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

API path operation docstrings and examples #177

Open
jimmymathews opened this issue Jul 14, 2023 · 0 comments
Open

API path operation docstrings and examples #177

jimmymathews opened this issue Jul 14, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@jimmymathews
Copy link
Collaborator

The autogenerated documentation for the API path operations supports example parameters and I think possibly examples responses as well. This would be a great addition to improve the usefulness of the docs page.

Also add expanded docstrings for each path operation (currently extremely minimal one-liners).
@jimmymathews jimmymathews added the documentation Improvements or additions to documentation label Jul 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jimmymathews