feat: document and comprehensively test download endpoints (#5) - #129
Open
XananasX7 wants to merge 1 commit into
Open
feat: document and comprehensively test download endpoints (#5)#129XananasX7 wants to merge 1 commit into
XananasX7 wants to merge 1 commit into
Conversation
- Document /files/download?file_path= and /files/download/[[file_path]] in README - Add download routes to the API index page - Add files-download.test.ts with 8 tests covering: - Text file download via query param (file_path and file_id) - Binary file download via query param with byte verification - 404 handling for missing files (query param) - Text file download via path form (nested paths) - Binary file download via path form with byte verification - 404 handling for missing files (path form) - Single-segment top-level file path form Closes tscircuit#5
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.
Summary
Implements the requirements from #5 — the
/files/downloadendpoint.The download endpoints already existed in the codebase; this PR:
Download Endpoints Implemented
Query parameter form
Path URL form
Both endpoints return files with:
Content-Disposition: attachment; filename="..."for browser download promptsContent-Type: text/plainfor text filesContent-Type: application/octet-stream+Content-Lengthfor binary files404when file is not foundTests Added
tests/routes/files-download.test.tswith 8 tests:Validation
/claim #5