Improve clarity in OpenAPI documentation section #9874
+7
−6
Conversation
This file contains hidden or 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
Corrected the hyphenation in the section title and added a note on using third-party packages for OpenAPI support.
Clarified wording about API documentation options.
Member
browniebroke
left a comment
browniebroke
left a comment
There was a problem hiding this comment.
Sure why not. I think we could make the notice in the built-in section more prominent:
It would benefit from being an admonition:
!!! warning
Deprecation notice: ...
Would you mind adding this change please? Thanks!
Updated deprecation notice for OpenAPI schema generation to clarify the recommendation for using drf-spectacular.
RispaJoseph
commented
Jan 23, 2026
Author
RispaJoseph
left a comment
RispaJoseph
left a comment
There was a problem hiding this comment.
Thanks for the suggestion! I’ve updated the built-in OpenAPI section to use a properly formatted warning admonition so the deprecation notice is more prominent.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Note: Before submitting a code change, please review our contributing guidelines.
Description
This PR improves clarity in the OpenAPI documentation by adding a brief explanation of why third-party packages are recommended.
No functional changes.