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

refactor(Django): improve API documentation #379

Merged
merged 7 commits into from
Aug 5, 2024

Conversation

raphodn
Copy link
Member

@raphodn raphodn commented Aug 4, 2024

What

Changes regarding the API :

  • move the docs endpoint out of the v1 namespace
  • add serializers to login & session endpoints
  • status endpoint : add a tag, and a response serializer
  • fix Proof default queryset
  • add APPEND_SLASH = False to avoid redirects, and trailing_slash=False in DRF setup
  • fix decimal warning

Todo

- open_prices/api/auth/views.py: Warning [SessionView]: could not resolve authenticator <class 'open_prices.common.authentication.CustomAuthentication'>. There was no OpenApiAuthenticationExtension registered for that class. Try creating one by subclassing it. Ignoring for now.
- open_prices/api/prices/views.py: Warning [PriceViewSet]: could not resolve authenticator <class 'open_prices.common.authentication.CustomAuthentication'>. There was no OpenApiAuthenticationExtension registered for that class. Try creating one by subclassing it. Ignoring for now.
- open_prices/api/proofs/views.py: Warning [ProofViewSet]: could not resolve authenticator <class 'open_prices.common.authentication.CustomAuthentication'>. There was no OpenApiAuthenticationExtension registered for that class. Try creating one by subclassing it. Ignoring for now.

@raphodn raphodn marked this pull request as ready for review August 5, 2024 12:42
@raphodn raphodn merged commit 606119a into raphodn/django-5-rewrite Aug 5, 2024
2 checks passed
@raphodn raphodn deleted the raphodn/django-5-api-fixes branch August 5, 2024 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant