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

Make Swagger Docs Better #3910

Open
dfitchett opened this issue Dec 20, 2024 · 0 comments
Open

Make Swagger Docs Better #3910

dfitchett opened this issue Dec 20, 2024 · 0 comments
Labels
disability-max-ratings-api Ticket related to the disability-max-ratings-api repo

Comments

@dfitchett
Copy link
Contributor

Swagger docs can be made more informative by providing things like:

  • example requests
  • example responses
  • error responses
    Other improvements are encouraged. Swagger docs are generated automatically by FastAPI and pydantic and should be programatically updated as outlined in the docs.
@dfitchett dfitchett added the disability-max-ratings-api Ticket related to the disability-max-ratings-api repo label Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
disability-max-ratings-api Ticket related to the disability-max-ratings-api repo
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dfitchett