chore(api): remove OpenAPI/Swagger integration #3770
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `django-rest-framework`'s built-in support for OpenAPI schema generation has been deprecated (encode/django-rest-framework#8773). `drf-spectacular` is the recommended alternative, but CourtListener's schema has always been experimental. Moreover the current integration is crashing and has other bugs that prevent its effective use. Outright removal, rather than replacement is the best way forward. Fixes: freelawproject#3653, freelawproject#1616
|
As-is change doesn’t mention removal in the REST API change log (or affect version), but it could: |
mlissner
approved these changes
Feb 13, 2024
|
Thanks Chad. Good to have this cleaned up. Setting for auto-merge! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
django-rest-framework's built-in support for OpenAPI schema generation has been deprecated (encode/django-rest-framework#8773).drf-spectacularis the recommended alternative, but CourtListener's schema has always been experimental. Moreover the current integration is crashing and has other bugs that prevent its effective use. Outright removal, rather than replacement is the best way forward.Fixes: #3653, #1616