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

Drf-spectacular #22478

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Drf-spectacular #22478

wants to merge 1 commit into from

Conversation

KevinMind
Copy link
Contributor

@KevinMind KevinMind commented Jul 16, 2024

Relates to: mozilla/addons#15019

Description

Replace drf_yasg with drf_spectacular as the more maintained and v3 supporting library. The new lib has better control over documenting serializers and supports the openapi spec v3 which natively has better type support.

https://drf-spectacular.readthedocs.io/en/latest/drf_yasg.html

Testing

Run the application locally:

make up

Now open the api docs: http://olympia.test/api/v5/swagger

Expect the docs to load, you should see operations and descriptions.

Checklist

  • Add #ISSUENUM at the top of your PR to an existing open issue in the mozilla/addons repository.
  • Successfully verified the change locally.
  • The change is covered by automated tests, or otherwise indicated why doing so is unnecessary/impossible.
  • Add before and after screenshots (Only for changes that impact the UI).
  • Add or update relevant docs reflecting the changes made.

@KevinMind KevinMind force-pushed the drf-spectacular branch 2 times, most recently from da8bf38 to 4bb6a48 Compare September 11, 2024 08:37
@KevinMind KevinMind force-pushed the drf-spectacular branch 5 times, most recently from 8e1b2c8 to 8fc7838 Compare September 18, 2024 10:56
@KevinMind KevinMind requested review from a team and diox and removed request for a team September 18, 2024 12:29
@KevinMind KevinMind marked this pull request as ready for review September 18, 2024 12:32
@KevinMind KevinMind force-pushed the drf-spectacular branch 4 times, most recently from bc6f99a to ad351f0 Compare September 20, 2024 08:53
@diox
Copy link
Member

diox commented Sep 20, 2024

Should I wait until #22663 is merged before reviewing this ? Or could you remove that commit (6b9dbdc) ? It makes the diff a lot bigger and harder to follow.

@KevinMind KevinMind marked this pull request as draft October 7, 2024 08:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants