Omit include parameter from OpenAPI schema when left unused #1157
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
sliverc
approved these changes
Jun 12, 2023
There was a problem hiding this comment.
Thanks for this addition. I am happy to merge this.
Just for your information the OpenAPI schema support within DJA will be deprecated in the near future, see discussion at #1082. The recommended way will be to use drf-spectecular-json-api. Best have a look there and see whether you can support the project.
5 tasks
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.
Description of the Change
Omits the
#/components/parameters/includereference from operation parameters if the given serializer does not implementincluded_serializers.At least the documentation makes it seem that
included_serializersis the only official way of adding include to the parameters, so I assume checking it like this would be safe.Checklist
CHANGELOG.mdupdated (only for user relevant changes)AUTHORS