query validation filter #481
Merged
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
Not sure it's needed, but the docmentation says to do it.
- allow the example app to still run, just failing any JSONAPIDjangoFilter tests. - split the two filters into separate files for easier maintenance.
- Had a mistake (unquoted '.') and missing '-' as an allowed character. Also '_' already in '\w' - Don't be so exhaustive in testing for invalid filters; let JSONAPIQueryValidationFilter (when available) deal with that.
…ing lots of older tests that use non-standard query params like page_size
sliverc
requested changes
Sep 18, 2018
There was a problem hiding this comment.
This PR came quicker than I have anticipated. Great. 😉
I like how it's implemented now where just all possible JSON API query parameters are listed and not trying to guess query params by different classes. 👍
In general it looks good. See some comments above.
…lter query parameter. This makes a consistent error message irrespective of whether QueryParameterValidation is used.
…ery param validation (not queryset)
|
@sliverc Thanks for letting me sneak this into 2.6.0! |
sliverc
approved these changes
Sep 19, 2018
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
Rounds out the suite of JSON:API backend filters with one that checks for mandatory query parameter names and returns a 400 if one that doesn't match is seen, or if a param like
sortis repeated. This makes for a more positive client developer experience in that incorrect query params (typos, etc.) are reported as errors rather than being silently ignored.Checklist
CHANGELOG.mdAUTHORSChangelog is already covered by "Add optional jsonapi-style filter backends. See usage docs" from prior filters.
Commit history is pretty ugly because this was authored a while ago and then a bunch of new master commits were merged. This should be squashed when merged.