docs(cryptify): document notifyRecipients on /fileupload/init#46
Merged
rubenhensen merged 1 commit intomainfrom May 5, 2026
Merged
docs(cryptify): document notifyRecipients on /fileupload/init#46rubenhensen merged 1 commit intomainfrom
rubenhensen merged 1 commit intomainfrom
Conversation
Closes #41 The /fileupload/init endpoint description listed an inaccurate parameter set and the finalize description claimed the recipient email always fires. Both were stale after cryptify#135 added the optional notifyRecipients toggle. Replace the one-line summary with an accurate parameter list (recipient, mailContent, mailLang, confirm, notifyRecipients), pin the source link to the post-merge cryptify hash, and reword finalize to reflect the notify-on-init contract.
rubenhensen
approved these changes
May 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #41.
What changed
docs/repos/cryptify.mdAPI section:POST /fileupload/initwas inaccurate (listedsender emailandfile size, which are not in the request body) and missing two parameters:confirmand the newnotifyRecipientsfrom cryptify#135.notifyRecipientswastrueon init", which matches the post-PR-135 behaviour.notifyRecipientstotruewhen the field is omitted on the wire; SDK clients (@e4a/pg-js1.2.0+,E4A.PostGuard0.3.0+) sendfalseexplicitly to keep silent-by-default semantics regardless of cryptify version.[Source: api-description.yaml#L33-L72]link at the post-merge cryptify hash723c8db1.The rest of the API section was skimmed for other phrasing that assumed the recipient mail always fires; only the finalize line needed touching.
Verification
npm run docs:buildis green (10s build, no warnings beyond the pre-existing chunk-size note).docs/.vitepress/dist/repos/cryptify.htmlfornotifyRecipientsandfileupload/init. Both render./fileupload/initrequest body at the pinned hash.Reviewer quickstart
Then open
/repos/cryptifyand check the new request-body table under## API.