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.

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

remove fastapi_responses, add manual additional responses docs #1385

Merged
merged 2 commits into from
Oct 19, 2024

Conversation

govfvck
Copy link
Contributor

@govfvck govfvck commented Oct 19, 2024

The fastapi_responses library is not maintained anymore and does not find additional responses (HTTPException) correctly, and some of the responses are not documented very well in the autogenerated docs.

  • removed fastapi_responses
  • add app/utils/responses.py to add aditional responses models.
  • add additional responses to the route operations to be included in the autogenerated docs.

for example create_admin route:

Before:
image

After:
image

I think this a good solution for now, so we could find a better way (maybe automatic) for this.

@ImMohammad20000 ImMohammad20000 added Doc Improvements or additions to documentation Backend API labels Oct 19, 2024
@ImMohammad20000 ImMohammad20000 merged commit eacf68e into Gozargah:dev Oct 19, 2024
@govfvck govfvck deleted the doc-extra-responses branch October 20, 2024 08:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Backend Doc Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants