Changeset 53315

Timestamp:

04/29/2022 04:53:55 PM (4 years ago)

Author:

johnbillion

Message:

REST API: Correct the schema for the wp/v2/block-directory/search endpoint.

Props zieladam, TimothyBlynJacobs, spacedmonkey, johnbillion

Fixes #53621

Location:

trunk

Files:

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

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

@@ -240 +240 @@
                 'rating'              => array(
                     'description' => __( 'The star rating of the block.' ),
-                    'type'        => 'integer',
+                    'type'        => 'number',
                     'context'     => array( 'view' ),
                 ),
@@ -250 +250 @@
                 'active_installs'     => array(
                     'description' => __( 'The number sites that have activated this block.' ),
-                    'type'        => 'string',
+                    'type'        => 'integer',
                     'context'     => array( 'view' ),
                 ),
                 'author_block_rating' => array(
                     'description' => __( 'The average rating of blocks published by the same author.' ),
-                    'type'        => 'integer',
+                    'type'        => 'number',
                     'context'     => array( 'view' ),
                 ),

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

@@ -211 +211 @@
         $this->assertArrayHasKey( 'last_updated', $properties );
         $this->assertArrayHasKey( 'humanized_updated', $properties );
+    }
+
+    /**
+     * @ticket 53621
+     */
+    public function test_get_items_response_conforms_to_schema() {
+        wp_set_current_user( self::$admin_id );
+        $plugin = $this->get_mock_plugin();
+
+        // Fetch the block directory schema.
+        $request = new WP_REST_Request( 'OPTIONS', '/wp/v2/block-directory/search' );
+        $schema  = rest_get_server()->dispatch( $request )->get_data()['schema'];
+
+        add_filter(
+            'plugins_api',
+            static function () use ( $plugin ) {
+                return (object) array(
+                    'info'    =>
+                        array(
+                            'page'    => 1,
+                            'pages'   => 1,
+                            'results' => 1,
+                        ),
+                    'plugins' => array(
+                        $plugin,
+                    ),
+                );
+            }
+        );
+
+        // Fetch a block plugin.
+        $request = new WP_REST_Request( 'GET', '/wp/v2/block-directory/search' );
+        $request->set_query_params( array( 'term' => 'cache' ) );
+
+        $result = rest_get_server()->dispatch( $request );
+        $data   = $result->get_data();
+
+        $valid = rest_validate_value_from_schema( $data[0], $schema );
+
+        $this->assertNotWPError( $valid );
     }