Documentation for routes functions#77
Open
joeljoby02 wants to merge 8 commits into
Open
Conversation
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.
Refactor route handler documentation
Remove async wrapper functions and add direct JSDoc comments to route definitions for cleaner documentation without middleware conflicts.
Changes
handleCreate()wrapper, added JSDoc aboverouter.route('/')documenting POST /v1/api/create endpoint, JWT auth requirement, request body parameters, and response formathandleDelete()wrapper, added JSDoc documenting DELETE endpoints (both root and :_id paths), auth requirement, optional path parameter, and response formathandleQuery()andhandleQueryHead()wrappers, added JSDoc documenting POST and HEAD /v1/api/query endpoints, public access (no auth), query body parameters, and response formathandleId()andhandleIdHead()wrappers, added JSDoc documenting GET and HEAD /v1/id/:_id endpoints, public access (no auth), path parameters, and response formathandleRelease()wrapper, added JSDoc documenting PATCH /v1/api/release/:_id endpoint, JWT auth requirement, path parameter, and response formathandleSearchAsWords()andhandleSearchAsPhrase()wrappers, added JSDoc for both POST /v1/api/search and POST /v1/api/search/phrase endpoints, public access (no auth), query parameters, and response formatRationale