API Option Handling #5516
Merged
API Option Handling #5516
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
|
Looks good! 👍 |
ErisDS
force-pushed
the
issue-2758-api-opts
branch
3 times, most recently
from
a4e8003
to
e044136
Compare
refs TryGhost#2758 - add a set of default options to utils - update validation function to only pass through permitted options - pass permitted options into validate where necessary - setup basic validation for each known option, and generic validation for the remainder - change slug to treat 'name' as data, rather than an option
|
I think I need to factor out the custom validation function for user edit & add a few extra integration tests for good measure... brb... |
|
I'm losing it, custom validation functions are removed already. Double checked what's getting integration tested in the API, it's weirdly split between the integration and route tests, but I'm happy with the coverage and that's not something to fix in this PR. I'll add better coverage of tags & pagination in general in the integration tests when I fix #5551, or as a separate commit to clear up and clarify what should be tested in the route vs integration tests. I believe that this is ready. |
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.
This PR adds basic filtering of options so that only the permitted ones get passed through to the next function.
It does not yet add checking if the values of the options are valid and it also does not throw an error if an invalid option is passed in. This additional structure unblocks adding and changing the options in a more testable way (e.g. adding a
fieldsparameter, whereas adding value checks will take more time.I'm not sure about the need to return an error if the passed options aren't allowed?
refs #2758