sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

REST API: Support the minProperties and maxProperties JSON Schema keywords. 

Props yakimun.
Fixes #51023.


git-svn-id: https://develop.svn.wordpress.org/trunk@49053 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Timothy Jacobs 2020-09-26 18:18:53 +00:00
parent 9aa0e0c92b
commit d5c2c86bd8
4 changed files with 71 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/wp-includes/rest-api.php
View File

@ -1551,6 +1551,7 @@ function rest_stabilize_value( $value ) {
* Support the "minLength", "maxLength" and "pattern" keywords for strings.
* Support the "minItems", "maxItems" and "uniqueItems" keywords for arrays.
* Validate required properties.
* @since 5.7.0 Support the "minProperties" and "maxProperties" keywords for objects.
*
* @param mixed $value The value to validate.
* @param array $args Schema array to use for validation.
@ -1662,6 +1663,16 @@ function rest_validate_value_from_schema( $value, $args, $param = '' ) {
}
}
}
if ( isset( $args['minProperties'] ) && count( $value ) < $args['minProperties'] ) {
/* translators: 1: Parameter, 2: Number. */
return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s must contain at least %2$s properties.' ), $param, number_format_i18n( $args['minProperties'] ) ) );
}
if ( isset( $args['maxProperties'] ) && count( $value ) > $args['maxProperties'] ) {
/* translators: 1: Parameter, 2: Number. */
return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s must contain at most %2$s properties.' ), $param, number_format_i18n( $args['maxProperties'] ) ) );
}
}
if ( 'null' === $args['type'] ) {
@ -2281,6 +2292,8 @@ function rest_get_endpoint_args_for_schema( $schema, $method = WP_REST_Server::C
'items',
'properties',
'additionalProperties',
'minProperties',
'maxProperties',
'minimum',
'maximum',
'exclusiveMinimum',

2
tests/phpunit/tests/rest-api/rest-controller.php
View File

@ -291,7 +291,7 @@ class WP_Test_REST_Controller extends WP_Test_REST_TestCase {
$this->assertArrayHasKey( $property, $args['somearray'] );
}
foreach ( array( 'properties', 'additionalProperties' ) as $property ) {
foreach ( array( 'properties', 'additionalProperties', 'minProperties', 'maxProperties' ) as $property ) {
$this->assertArrayHasKey( $property, $args['someobject'] );
}

55
tests/phpunit/tests/rest-api/rest-schema-validation.php
View File

@ -836,6 +836,61 @@ class WP_Test_REST_Schema_Validation extends WP_UnitTestCase {
);
}
/**
* @ticket 51023
*/
public function test_object_min_properties() {
$schema = array(
'type' => 'object',
'minProperties' => 1,
);
$this->assertTrue(
rest_validate_value_from_schema(
array(
'propA' => 'a',
'propB' => 'b',
),
$schema
)
);
$this->assertTrue( rest_validate_value_from_schema( array( 'propA' => 'a' ), $schema ) );
$this->assertWPError( rest_validate_value_from_schema( array(), $schema ) );
$this->assertWPError( rest_validate_value_from_schema( '', $schema ) );
}
/**
* @ticket 51023
*/
public function test_object_max_properties() {
$schema = array(
'type' => 'object',
'maxProperties' => 2,
);
$this->assertTrue( rest_validate_value_from_schema( array( 'propA' => 'a' ), $schema ) );
$this->assertTrue(
rest_validate_value_from_schema(
array(
'propA' => 'a',
'propB' => 'b',
),
$schema
)
);
$this->assertWPError(
rest_validate_value_from_schema(
array(
'propA' => 'a',
'propB' => 'b',
'propC' => 'c',
),
$schema
)
);
$this->assertWPError( rest_validate_value_from_schema( 'foobar', $schema ) );
}
/**
* @ticket 44949
*/

2
tests/phpunit/tests/rest-api/rest-test-controller.php
View File

@ -120,6 +120,8 @@ class WP_REST_Test_Controller extends WP_REST_Controller {
'type' => 'integer',
),
),
'minProperties' => 1,
'maxProperties' => 10,
'ignored_prop' => 'ignored_prop',
'context' => array( 'view' ),
),