-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Abilities API: Normalize input from schema #10395
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Abilities API: Normalize input from schema #10395
Conversation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
09a9620 to
eac1d00
Compare
eac1d00 to
d48cdcd
Compare
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
bf6f157 to
2cd9757
Compare
jorgefilipecosta
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code change looks and is properly tested 👍
Without this patch REST API would require a weird empty `?input` field for optional input given how the current controller works with input schema when it defines the expected shape. This patch normalizes the input for the ability, applying the default value from the input schema when needed. Developed in #10395. Follow-up [61032], [61045]. Props gziolo, jorgefilipecosta, mukesh27. Fixes #64139. git-svn-id: https://develop.svn.wordpress.org/trunk@61047 602fd350-edb4-49c9-b593-d223f7449a82
Without this patch REST API would require a weird empty `?input` field for optional input given how the current controller works with input schema when it defines the expected shape. This patch normalizes the input for the ability, applying the default value from the input schema when needed. Developed in WordPress/wordpress-develop#10395. Follow-up [61032], [61045]. Props gziolo, jorgefilipecosta, mukesh27. Fixes #64139. Built from https://develop.svn.wordpress.org/trunk@61047 git-svn-id: http://core.svn.wordpress.org/trunk@60383 1a063a9b-81f0-0310-95a4-ce76da25c4cd
Without this patch REST API would require a weird empty `?input` field for optional input given how the current controller works with input schema when it defines the expected shape. This patch normalizes the input for the ability, applying the default value from the input schema when needed. Developed in WordPress/wordpress-develop#10395. Follow-up [61032], [61045]. Props gziolo, jorgefilipecosta, mukesh27. Fixes #64139. Built from https://develop.svn.wordpress.org/trunk@61047 git-svn-id: https://core.svn.wordpress.org/trunk@60383 1a063a9b-81f0-0310-95a4-ce76da25c4cd
Trac ticket: https://core.trac.wordpress.org/ticket/64139
Bug fix extracted from WordPress/abilities-api#108.
The problem
Without this patch REST would require a weird empty
?inputfield given how the current controller works with input schema that defines specific shape, example:Working examples:
GET
/run?input# All fieldsGET
/run?input[fields][]=name # FilteredWe want the REST API controller to infer default value from the input schema, so it's possible to call:
GET
/run# All fieldsSolution
Normalizes the input for the ability, applying the default value from the input schema when needed.
When no input is provided and the input schema is defined with a top-level
defaultkey, this method returns the value of that key. If the input schema does not define adefault, or if the input schema is empty, this method returns null. If input is provided, it is returned as-is.This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.