Changeset 49053

Timestamp:

09/26/2020 06:18:53 PM (4 years ago)

Author:

TimothyBlynJacobs

Message:

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

Props yakimun.
Fixes #51023.

Location:

trunk

Files:

• src/wp-includes/rest-api.php (modified) (3 diffs)
• 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

@@ -1552 +1552 @@
  *              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.
@@ -1662 +1663 @@
                 }
             }
+        }
+
+        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'] ) ) );
         }
     }
@@ -2282 +2293 @@
         'properties',
         'additionalProperties',
+        'minProperties',
+        'maxProperties',
         'minimum',
         'maximum',

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

@@ -292 +292 @@
         }
 
-        foreach ( array( 'properties', 'additionalProperties' ) as $property ) {
+        foreach ( array( 'properties', 'additionalProperties', 'minProperties', 'maxProperties' ) as $property ) {
             $this->assertArrayHasKey( $property, $args['someobject'] );
         }

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

@@ -838 +838 @@
 
     /**
+     * @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
      */

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

@@ -121 +121 @@
                         ),
                     ),
+                    'minProperties'        => 1,
+                    'maxProperties'        => 10,
                     'ignored_prop'         => 'ignored_prop',
                     'context'              => array( 'view' ),