Added ExcludeFieldsMixin to exclude fields via query parameters#872
Open
calumbell wants to merge 2 commits intoopen5e:stagingfrom
Open
Added ExcludeFieldsMixin to exclude fields via query parameters#872calumbell wants to merge 2 commits intoopen5e:stagingfrom
ExcludeFieldsMixin to exclude fields via query parameters#872calumbell wants to merge 2 commits intoopen5e:stagingfrom
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
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
This PR adds in the
ExcludeFieldsMixinwhich supports the use of anexcludequery parameter, which defines a list of serializer fields that the API user wants to exclude from an API response.This solves an issue where users were trying to omit one or two fields from an API response, and having the use the
?fields=query parameter, and adding every single serializer fields except for theUsages
The new mixin can be found at
api_v2/views/mixins/exclude_fields_mixin.pyand can be applied to a View by inheriting from the mixin:The
ExampleViewSetview should how support filtering via the?exclude=query parameterOverview of Changes
api_v2/views/mixins/exclude_fields_mixin.pyfile.ExcludeFieldsMixinto the View inheritance chain.api_v2/views/mixinsdirectory. To me, these leads to much better DXRelated Issue
Closes #871
How was this tested?
pytest- all tests passing