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

Refactored drf_yasg OpenAPI Swagger generator to local only #524

Merged
merged 1 commit into from
Nov 11, 2022

Conversation

victorskl
Copy link
Member

  • drf_yasg is auxiliary component for swagger auto generation purpose
    only. Plus, this package is aging and need replace with drf-spectacular
    at some point. See note
    https://drf-yasg.readthedocs.io/en/stable/readme.html#openapi-3-0-note
  • This essentially fix drf_yasg issue with DistributionNotFound on
    pkg_resources.get_distribution("djangorestframework").version scanning.
  • Minor improved Serverless deploy settings
  • Added CORS allow origins for newer domains

* `drf_yasg` is auxiliary component for swagger auto generation purpose
  only. Plus, this package is aging and need replace with `drf-spectacular`
  at some point. See note
  https://drf-yasg.readthedocs.io/en/stable/readme.html#openapi-3-0-note
* This essentially fix `drf_yasg` issue with `DistributionNotFound` on
  `pkg_resources.get_distribution("djangorestframework").version` scanning.
* Minor improved Serverless deploy settings
* Added CORS allow origins for newer domains
@victorskl victorskl self-assigned this Nov 11, 2022
@victorskl victorskl added documentation Improvements or additions to documentation cicd CI/CD Builds and Deployment refactor fix labels Nov 11, 2022
@victorskl
Copy link
Member Author

Folks; pls feel free to review/comment, if any. It is just Django stuff. I will be merging ahead as a bit short of time for release.

@victorskl victorskl added this to the Release 2.0 milestone Nov 11, 2022
@victorskl victorskl merged commit a8098a3 into dev Nov 11, 2022
@victorskl victorskl deleted the refactor-drf-yasg-swagger-local-only branch November 11, 2022 07:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cicd CI/CD Builds and Deployment documentation Improvements or additions to documentation fix refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant