docs(cryptify): document /status endpoint, recovery_token, structured 404, session_ttl_secs#69
Merged
Merged
Conversation
… 404, session_ttl_secs Closes #67 - Add session_ttl_secs row to the config table (cryptify#144). - Document the recovery_token field on the init response (cryptify#148). - Add a section for GET /fileupload/{uuid}/status (cryptify#148). - Describe the structured upload_session_not_found 404 body (cryptify#144). - Describe the idempotent chunk-retry contract (cryptify#145). All snippet links pin to commit 4c30e53 on cryptify main and were verified HTTP 200.
rubenhensen
approved these changes
May 8, 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
1 participant
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 #67.
Updates
docs/repos/cryptify.mdto cover the upload-protocol features merged on cryptifymain:session_ttl_secsconfig option (cryptify#144) — added to the config table with a note that the eviction deadline resets on each successful chunk PUT or/statuscall.recovery_tokenfield on thePOST /fileupload/initresponse (cryptify#148) — new subsection describing the response body.GET /fileupload/{uuid}/statusendpoint (cryptify#148) — new subsection covering the response shape,X-Recovery-Tokenauth (401vs deliberate404info-hiding), idle-deadline reset, and resume-conflict semantics.upload_session_not_found404 body (cryptify#144) — new subsection covering the JSON body and the threereasonvalues.(prev_token, offset, length, sha256)match, the 400 on body mismatch, and the link toprev_token/prev_offseton/status.All snippet links pin to cryptify commit
4c30e53onmain. Verified HTTP 200 on every link before commit.Verification
npm run docs:build— passes (5.23s).curl -sIon each new source link returns 200.Reviewer quickstart:
git fetch origin && git checkout docs/cryptify-status-and-recovery && npm install && npm run docs:dev