vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-07-01 15:50:09 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

REST API: Add support for the oneOf and anyOf keywords.

Browse Source 
This allows for REST API routes to define more complex validation requirements as JSON Schema instead of procedural validation.

The error code returned from `rest_validate_value_from_schema` for invalid parameter types has been changed from the generic `rest_invalid_param` to the more specific `rest_invalid_type`.

Props yakimun, johnbillion, TimothyBlynJacobs.
Fixes #51025.


git-svn-id: https://develop.svn.wordpress.org/trunk@49246 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Timothy Jacobs
2020-10-20 18:22:39 +00:00
parent 194d32b970
commit 54aa0bc7d1
10 changed files with 1546 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

234
tests/phpunit/tests/rest-api.php
View File

@@ -1085,7 +1085,7 @@ class Tests_REST_API extends WP_UnitTestCase {
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',
@@ -1106,7 +1106,7 @@ class Tests_REST_API extends WP_UnitTestCase {
),
array( 'first' => 'a' ),
),
'keeps missing context' => array(
'keeps missing context' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
@@ -1129,7 +1129,7 @@ class Tests_REST_API extends WP_UnitTestCase {
'second' => 'b',
),
),
'removes empty context' => array(
'removes empty context' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
@@ -1150,7 +1150,7 @@ class Tests_REST_API extends WP_UnitTestCase {
),
array( 'first' => 'a' ),
),
'nested properties' => array(
'nested properties' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
@@ -1179,7 +1179,7 @@ class Tests_REST_API extends WP_UnitTestCase {
),
array( 'parent' => array( 'child' => 'hi' ) ),
),
'grand child properties' => array(
'grand child properties' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
@@ -1215,7 +1215,7 @@ class Tests_REST_API extends WP_UnitTestCase {
),
array( 'parent' => array( 'child' => array( 'grand' => 'hi' ) ) ),
),
'array' => array(
'array' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
@@ -1250,7 +1250,7 @@ class Tests_REST_API extends WP_UnitTestCase {
),
array( 'arr' => array( array( 'visible' => 'hi' ) ) ),
),
'additional properties' => array(
'additional properties' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
@@ -1284,7 +1284,7 @@ class Tests_REST_API extends WP_UnitTestCase {
),
array( 'additional' => array( 'a' => '1' ) ),
),
'pattern properties' => array(
'pattern properties' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
@@ -1320,7 +1320,7 @@ class Tests_REST_API extends WP_UnitTestCase {
'0' => '3',
),
),
'multiple types object' => array(
'multiple types object' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
@@ -1349,7 +1349,7 @@ class Tests_REST_API extends WP_UnitTestCase {
),
array( 'multi' => array( 'a' => '1' ) ),
),
'multiple types array' => array(
'multiple types array' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
@@ -1384,7 +1384,7 @@ class Tests_REST_API extends WP_UnitTestCase {
),
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',
@@ -1427,7 +1427,7 @@ class Tests_REST_API extends WP_UnitTestCase {
),
),
),
'object with no matching properties' => array(
'object with no matching properties' => array(
array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'type' => 'object',
@@ -1448,7 +1448,7 @@ class Tests_REST_API extends WP_UnitTestCase {
),
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',
@@ -1468,7 +1468,7 @@ class Tests_REST_API extends WP_UnitTestCase {
),
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' ),
@@ -1506,7 +1506,7 @@ class Tests_REST_API extends WP_UnitTestCase {
'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' ),
@@ -1547,6 +1547,210 @@ class Tests_REST_API extends WP_UnitTestCase {
),
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,
),
),
);
}