docs: document download endpoints in API index page - #143
Open
singularitycurse26-svg wants to merge 1 commit into
Open
docs: document download endpoints in API index page#143singularitycurse26-svg wants to merge 1 commit into
singularitycurse26-svg wants to merge 1 commit into
Conversation
Add /files/download?file_path=... and /files/download/[[file_path]] to the API documentation on the index page. Both endpoints were already implemented but not listed in the API docs. Closes tscircuit#5 /claim 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
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.
Summary
Documents the download endpoints in the API index page.
Both
/files/download?file_path=...(query param) and/files/download/[[file_path]](path-based) endpoints were already implemented inroutes/files/download.tsandroutes/files/download/[[...file_path]].tsrespectively, but they were not listed in the API documentation on the index page.Changes
routes/index.ts: Added download endpoints to the API documentation listCloses #5
/claim #5