Changeset 47923

Timestamp:

06/07/2020 10:40:16 PM (5 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Support the (min|max)Items JSON Schema keywords.

A future commit will add support for the uniqueItems keyword.

Props sorenbronsted.
See #48821.

Location:

trunk

Files:

• src/wp-includes/rest-api.php (modified) (2 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-schema-validation.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-test-controller.php (modified) (1 diff)

trunk/src/wp-includes/rest-api.php

@@ -1251 +1251 @@
  *              Support the "minLength", "maxLength" and "pattern" keywords for strings.
  *              Validate required properties.
+ *              Support the "minItems" and "maxItems" keywords for arrays.
  *
  * @param mixed  $value The value to validate.
@@ -1287 +1288 @@
                 return $is_valid;
             }
+        }
+
+        if ( isset( $args['minItems'] ) && count( $value ) < $args['minItems'] ) {
+            /* translators: 1: Parameter, 2: number. */
+            return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s must contain at least %2$s items.' ), $param, number_format_i18n( $args['minItems'] ) ) );
+        }
+
+        if ( isset( $args['maxItems'] ) && count( $value ) > $args['maxItems'] ) {
+            /* translators: 1: Parameter, 2: number. */
+            return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s must contain at most %2$s items.' ), $param, number_format_i18n( $args['maxItems'] ) ) );
         }
     }

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php

@@ -644 +644 @@
             'maxLength',
             'pattern',
+            'minItems',
+            'maxItems',
         );
 

trunk/tests/phpunit/tests/rest-api/rest-controller.php

@@ -265 +265 @@
 
         $this->assertArrayHasKey( 'items', $args['somearray'] );
+
+        foreach ( array( 'minItems', 'maxItems' ) as $property ) {
+            $this->assertArrayHasKey( $property, $args['somearray'] );
+        }
 
         foreach ( array( 'properties', 'additionalProperties' ) as $property ) {

trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php

@@ -767 +767 @@
         $this->assertWPError( rest_validate_value_from_schema( 'ââ', $schema ) );
     }
+
+    /**
+     * @ticket 48821
+     */
+    public function test_array_min_items() {
+        $schema = array(
+            'type'     => 'array',
+            'minItems' => 1,
+            'items'    => array(
+                'type' => 'number',
+            ),
+        );
+
+        $this->assertTrue( rest_validate_value_from_schema( array( 1, 2 ), $schema ) );
+        $this->assertTrue( rest_validate_value_from_schema( array( 1 ), $schema ) );
+        $this->assertWPError( rest_validate_value_from_schema( array(), $schema ) );
+        $this->assertWPError( rest_validate_value_from_schema( '', $schema ) );
+    }
+
+    /**
+     * @ticket 48821
+     */
+    public function test_array_max_items() {
+        $schema = array(
+            'type'     => 'array',
+            'maxItems' => 2,
+            'items'    => array(
+                'type' => 'number',
+            ),
+        );
+
+        $this->assertTrue( rest_validate_value_from_schema( array( 1 ), $schema ) );
+        $this->assertTrue( rest_validate_value_from_schema( array( 1, 2 ), $schema ) );
+        $this->assertWPError( rest_validate_value_from_schema( array( 1, 2, 3 ), $schema ) );
+        $this->assertWPError( rest_validate_value_from_schema( 'foobar', $schema ) );
+    }
 }

trunk/tests/phpunit/tests/rest-api/rest-test-controller.php

@@ -102 +102 @@
                 ),
                 'somearray'      => array(
-                    'type'    => 'array',
-                    'items'   => array(
+                    'type'     => 'array',
+                    'items'    => array(
                         'type' => 'string',
                     ),
-                    'context' => array( 'view' ),
+                    'minItems' => 1,
+                    'maxItems' => 10,
+                    'context'  => array( 'view' ),
                 ),
                 'someobject'     => array(