Skip to content

REST API: Support the anyOf and oneOf JSON Schema keywords. #555

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.

Sign up for GitHub

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

Closed
ghost wants to merge 16 commits into from
Closed

REST API: Support the anyOf and oneOf JSON Schema keywords. #555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
4e9eadc
REST API: Support the anyOf JSON Schema keyword.
yakihub Sep 25, 2020
8af15c9
REST API: Support the oneOf JSON Schema keyword.
yakihub Sep 25, 2020
81bc3a5
Merge branch 'master' into 51025
yakihub Oct 1, 2020
3386d6f
REST API: Change type validation error codes to rest_invalid_type.
yakihub Oct 1, 2020
67a4723
REST API: Improve error messages of combined operations validation.
yakihub Oct 1, 2020
604ad10
REST API: Move anyOf and oneOf logic into separate functions.
yakihub Oct 4, 2020
1400553
REST API: Support the anyOf and oneOf JSON Schema keywords sanitization.
yakihub Oct 4, 2020
6687708
REST API: Support the anyOf and oneOf JSON Schema keywords filtering.
yakihub Oct 5, 2020
6fc0c0b
REST API: Improve the generation of combining operation errors.
yakihub Oct 7, 2020
1838e06
REST API: Rework the anyOf and oneOf tests.
yakihub Oct 7, 2020
2967691
REST API: Improve the generation of combining operation errors.
yakihub Oct 8, 2020
50773b3
REST API: Fix a linting error in the validation test.
yakihub Oct 8, 2020
445874e
Clean up translator comment positioning
TimothyBJacobs Oct 20, 2020
b249db6
Merge branch 'master' into 51025
TimothyBJacobs Oct 20, 2020
9bd2ef1
Simplify error messages.
TimothyBJacobs Oct 20, 2020
583f6ba
Add test for filter by context falling thru.
TimothyBJacobs Oct 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
349 changes: 333 additions & 16 deletions src/wp-includes/rest-api.php
View file
Open in desktop

Large diffs are not rendered by default.

234 changes: 219 additions & 15 deletions tests/phpunit/tests/rest-api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1085,7 +1085,7 @@ public function test_register_route_with_missing_permission_callback_multiple_wr

public function _dp_rest_filter_response_by_context() {
return array(
'default' => array(
'default' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
Expand All @@ -1106,7 +1106,7 @@ public function _dp_rest_filter_response_by_context() {
),
array( 'first' => 'a' ),
),
'keeps missing context' => array(
'keeps missing context' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
Expand All @@ -1129,7 +1129,7 @@ public function _dp_rest_filter_response_by_context() {
'second' => 'b',
),
),
'removes empty context' => array(
'removes empty context' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
Expand All @@ -1150,7 +1150,7 @@ public function _dp_rest_filter_response_by_context() {
),
array( 'first' => 'a' ),
),
'nested properties' => array(
'nested properties' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
Expand Down Expand Up @@ -1179,7 +1179,7 @@ public function _dp_rest_filter_response_by_context() {
),
array( 'parent' => array( 'child' => 'hi' ) ),
),
'grand child properties' => array(
'grand child properties' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
Expand Down Expand Up @@ -1215,7 +1215,7 @@ public function _dp_rest_filter_response_by_context() {
),
array( 'parent' => array( 'child' => array( 'grand' => 'hi' ) ) ),
),
'array' => array(
'array' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
Expand Down Expand Up @@ -1250,7 +1250,7 @@ public function _dp_rest_filter_response_by_context() {
),
array( 'arr' => array( array( 'visible' => 'hi' ) ) ),
),
'additional properties' => array(
'additional properties' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
Expand Down Expand Up @@ -1284,7 +1284,7 @@ public function _dp_rest_filter_response_by_context() {
),
array( 'additional' => array( 'a' => '1' ) ),
),
'pattern properties' => array(
'pattern properties' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
Expand Down Expand Up @@ -1320,7 +1320,7 @@ public function _dp_rest_filter_response_by_context() {
'0' => '3',
),
),
'multiple types object' => array(
'multiple types object' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
Expand Down Expand Up @@ -1349,7 +1349,7 @@ public function _dp_rest_filter_response_by_context() {
),
array( 'multi' => array( 'a' => '1' ) ),
),
'multiple types array' => array(
'multiple types array' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
Expand Down Expand Up @@ -1384,7 +1384,7 @@ public function _dp_rest_filter_response_by_context() {
),
array( 'multi' => array( array( 'visible' => '1' ) ) ),
),
'does not traverse missing context' => array(
'does not traverse missing context' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
Expand Down Expand Up @@ -1427,7 +1427,7 @@ public function _dp_rest_filter_response_by_context() {
),
),
),
'object with no matching properties' => array(
'object with no matching properties' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
Expand All @@ -1448,7 +1448,7 @@ public function _dp_rest_filter_response_by_context() {
),
array(),
),
'array whose type does not match' => array(
'array whose type does not match' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
Expand All @@ -1468,7 +1468,7 @@ public function _dp_rest_filter_response_by_context() {
),
array( 'arr' => array() ),
),
'array and object type passed object' => array(
'array and object type passed object' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => array( 'array', 'object' ),
Expand Down Expand Up @@ -1506,7 +1506,7 @@ public function _dp_rest_filter_response_by_context() {
'b' => 'bar',
),
),
'array and object type passed array' => array(
'array and object type passed array' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => array( 'array', 'object' ),
Expand Down Expand Up @@ -1547,6 +1547,210 @@ public function _dp_rest_filter_response_by_context() {
),
array(),
),
'anyOf applies the correct schema' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
'anyOf' => array(
array(
'properties' => array(
'a' => array(
'type' => 'string',
'context' => array( 'view' ),
),
'b' => array(
'type' => 'string',
'context' => array( 'edit' ),
),
),
),
array(
'properties' => array(
'a' => array(
'type' => 'integer',
'context' => array( 'edit' ),
),
'b' => array(
'type' => 'integer',
'context' => array( 'view' ),
),
),
),
),
),
array(
'a' => 1,
'b' => 2,
),
array(
'b' => 2,
),
),
'anyOf is ignored if no valid schema is found' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
'anyOf' => array(
array(
'properties' => array(
'a' => array(
'type' => 'string',
'context' => array( 'view' ),
),
'b' => array(
'type' => 'string',
'context' => array( 'edit' ),
),
),
),
array(
'properties' => array(
'a' => array(
'type' => 'integer',
'context' => array( 'edit' ),
),
'b' => array(
'type' => 'integer',
'context' => array( 'view' ),
),
),
),
),
),
array(
'a' => true,
'b' => false,
),
array(
'a' => true,
'b' => false,
),
),
'oneOf applies the correct schema' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
'oneOf' => array(
array(
'properties' => array(
'a' => array(
'type' => 'string',
'context' => array( 'view' ),
),
'b' => array(
'type' => 'string',
'context' => array( 'edit' ),
),
),
),
array(
'properties' => array(
'a' => array(
'type' => 'integer',
'context' => array( 'edit' ),
),
'b' => array(
'type' => 'integer',
'context' => array( 'view' ),
),
),
),
),
),
array(
'a' => 1,
'b' => 2,
),
array(
'b' => 2,
),
),
'oneOf ignored if no valid schema was found' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
'anyOf' => array(
array(
'properties' => array(
'a' => array(
'type' => 'string',
'context' => array( 'view' ),
),
'b' => array(
'type' => 'string',
'context' => array( 'edit' ),
),
),
),
array(
'properties' => array(
'a' => array(
'type' => 'integer',
'context' => array( 'edit' ),
),
'b' => array(
'type' => 'integer',
'context' => array( 'view' ),
),
),
),
),
),
array(
'a' => true,
'b' => false,
),
array(
'a' => true,
'b' => false,
),
),
'oneOf combined with base' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
'properties' => array(
'c' => array(
'type' => 'integer',
'context' => array( 'edit' ),
),
),
'oneOf' => array(
array(
'properties' => array(
'a' => array(
'type' => 'string',
'context' => array( 'view' ),
),
'b' => array(
'type' => 'string',
'context' => array( 'edit' ),
),
),
),
array(
'properties' => array(
'a' => array(
'type' => 'integer',
'context' => array( 'edit' ),
),
'b' => array(
'type' => 'integer',
'context' => array( 'view' ),
),
),
),
),
),
array(
'a' => 1,
'b' => 2,
'c' => 3,
),
array(
'b' => 2,
),
),
);
}

Expand Down
Loading