Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

support documentation for path parameters #167

Closed
juliuste opened this issue Jun 21, 2021 · 1 comment · Fixed by #677
Closed

support documentation for path parameters #167

juliuste opened this issue Jun 21, 2021 · 1 comment · Fixed by #677

Comments

@juliuste
Copy link

Disclaimer: Sorry for opening yet another issue, please close if out of scope/not useful. I'm currently integrating this library into a project that previously had a hand-written openapi doc, so I'm creating an issue here everytime I encounter a situation where the library doesn't (yet) allow what can be achieved by hand.

It would be cool if the library provided a way to add docs for path parameters. I'm not sure where exactly one would put the corresponding JSDoc comments, maybe in the Routes main comment block, as is already the case for annotations to @response codes.
@wilbrt wilbrt mentioned this issue May 24, 2023
Merged
@akheron
Copy link
Owner

akheron commented May 27, 2023

Fixed in #677

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Allow documenting route parameters
2 participants
@akheron @juliuste