Ticket #40510: 40510.3.diff

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

@@ -201 +201 @@
                         return $parent;
                 }
 
-                $revisions = wp_get_post_revisions( $request['parent'] );
+                // Ensure a search string is set in case the orderby is set to 'relevance'.
+                if ( ! empty( $request['orderby'] ) && 'relevance' === $request['orderby'] && empty( $request['search'] ) ) {
+                        return new WP_Error( 'rest_no_search_term_defined', __( 'You need to define a search term to order by relevance.' ), array( 'status' => 400 ) );
+                }
+
+                // Ensure an include parameter is set in case the orderby is set to 'include'.
+                if ( ! empty( $request['orderby'] ) && 'include' === $request['orderby'] && empty( $request['include'] ) ) {
+                        return new WP_Error( 'rest_orderby_include_missing_include', __( 'You need to define an include parameter to order by include.' ), array( 'status' => 400 ) );
+                }
+
+                if ( wp_revisions_enabled( $parent ) ) {
+                        $registered = $this->get_collection_params();
+                        $args       = array(
+                                'post_parent'      => $parent->ID,
+                                'post_type'        => 'revision',
+                                'post_status'      => 'inherit',
+                                'posts_per_page'   => -1,
+                                'suppress_filters' => true,
+                        );
+
+                        $parameter_mappings = array(
+                                'exclude'  => 'post__not_in',
+                                'include'  => 'post__in',
+                                'offset'   => 'offset',
+                                'order'    => 'order',
+                                'orderby'  => 'orderby',
+                                'page'     => 'paged',
+                                'per_page' => 'posts_per_page',
+                                'search'   => 's',
+                        );
+
+                        foreach ( $parameter_mappings as $api_param => $wp_param ) {
+                                if ( isset( $registered[ $api_param ], $request[ $api_param ] ) ) {
+                                        $args[ $wp_param ] = $request[ $api_param ];
+                                }
+                        }
+
+                        /** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php */
+                        $args       = apply_filters( "rest_revision_query", $args, $request );
+                        $query_args = $this->prepare_items_query( $args, $request );
+
+                        $revisions_query = new WP_Query();
+                        $revisions       = $revisions_query->query( $query_args );
+                        $offset          = isset( $query_args['offset'] ) ? (int) $query_args['offset'] : 0;
+                        $page            = (int) $query_args['paged'];
+                        $total_revisions = $revisions_query->found_posts;
+
+                        if ( $total_revisions < 1 ) {
+                                // Out-of-bounds, run the query again without LIMIT for total count.
+                                unset( $query_args['paged'], $query_args['offset'] );
+
+                                $count_query = new WP_Query();
+                                $count_query->query( $query_args );
+
+                                $total_revisions = $count_query->found_posts;
+                        }
+
+                        if ( $revisions_query->query_vars['posts_per_page'] > 0 ) {
+                                $max_pages = ceil( $total_revisions / (int) $revisions_query->query_vars['posts_per_page'] );
+                        } else {
+                                $max_pages = $total_revisions > 0 ? 1 : 0;
+                        }
+
+                        if ( $total_revisions > 0 ) {
+                                if ( $page > $max_pages ) {
+                                        return new WP_Error( 'rest_revision_invalid_page_number', __( 'The page number requested is larger than the number of pages available.' ), array( 'status' => 400 ) );
+                                } elseif ( $offset > $total_revisions ) {
+                                        return new WP_Error( 'rest_revision_invalid_offset_number', __( 'The offset number requested is larger than the number of available revisions.' ), array( 'status' => 400 ) );
+                                }
+                        }
+                } else {
+                        $revisions       = array();
+                        $total_revisions = 0;
+                        $max_pages       = 0;
+                        $page            = (int) $request['page'];
+                }
 
                 $response = array();
                 foreach ( $revisions as $revision ) {
                         $data       = $this->prepare_item_for_response( $revision, $request );
                         $response[] = $this->prepare_response_for_collection( $data );
                 }
-                return rest_ensure_response( $response );
+
+                $response = rest_ensure_response( $response );
+
+                $response->header( 'X-WP-Total', (int) $total_revisions );
+                $response->header( 'X-WP-TotalPages', (int) $max_pages );
+
+                $request_params = $request->get_query_params();
+                $base           = add_query_arg( $request_params, rest_url( sprintf( '%s/%s/%d/%s', $this->namespace, $this->parent_base, $request['parent'], $this->rest_base ) ) );
+
+                if ( $page > 1 ) {
+                        $prev_page = $page - 1;
+
+                        if ( $prev_page > $max_pages ) {
+                                $prev_page = $max_pages;
+                        }
+
+                        $prev_link = add_query_arg( 'page', $prev_page, $base );
+                        $response->link_header( 'prev', $prev_link );
+                }
+                if ( $max_pages > $page ) {
+                        $next_page = $page + 1;
+                        $next_link = add_query_arg( 'page', $next_page, $base );
+
+                        $response->link_header( 'next', $next_link );
+                }
+
+                return $response;
         }
 
         /**
@@ -327 +428 @@
         }
 
         /**
+         * Determines the allowed query_vars for a get_items() response and prepares
+         * them for WP_Query.
+         *
+         * @since 5.0.0
+         *
+         * @param array           $prepared_args Optional. Prepared WP_Query arguments. Default empty array.
+         * @param WP_REST_Request $request       Optional. Full details about the request.
+         * @return array Items query arguments.
+         */
+        protected function prepare_items_query( $prepared_args = array(), $request = null ) {
+                $query_args = array();
+
+                foreach ( $prepared_args as $key => $value ) {
+                        /** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php */
+                        $query_args[ $key ] = apply_filters( "rest_query_var-{$key}", $value );
+                }
+
+                // Map to proper WP_Query orderby param.
+                if ( isset( $query_args['orderby'] ) && isset( $request['orderby'] ) ) {
+                        $orderby_mappings = array(
+                                'id'            => 'ID',
+                                'include'       => 'post__in',
+                                'slug'          => 'post_name',
+                                'include_slugs' => 'post_name__in',
+                        );
+
+                        if ( isset( $orderby_mappings[ $request['orderby'] ] ) ) {
+                                $query_args['orderby'] = $orderby_mappings[ $request['orderby'] ];
+                        }
+                }
+
+                return $query_args;
+        }
+
+        /**
          * Prepares the revision for the REST response.
          *
          * @since 4.7.0
@@ -547 +683 @@
          * @return array Collection parameters.
          */
         public function get_collection_params() {
-                return array(
-                        'context' => $this->get_context_param( array( 'default' => 'view' ) ),
+                $query_params = parent::get_collection_params();
+
+                $query_params['context']['default'] = 'view';
+
+                unset( $query_params['per_page']['default'] );
+
+                $query_params['exclude'] = array(
+                        'description' => __( 'Ensure result set excludes specific IDs.' ),
+                        'type'        => 'array',
+                        'items'       => array(
+                                'type' => 'integer',
+                        ),
+                        'default'     => array(),
+                );
+
+                $query_params['include'] = array(
+                        'description' => __( 'Limit result set to specific IDs.' ),
+                        'type'        => 'array',
+                        'items'       => array(
+                                'type' => 'integer',
+                        ),
+                        'default'     => array(),
+                );
+
+                $query_params['offset'] = array(
+                        'description' => __( 'Offset the result set by a specific number of items.' ),
+                        'type'        => 'integer',
                 );
+
+                $query_params['order'] = array(
+                        'description' => __( 'Order sort attribute ascending or descending.' ),
+                        'type'        => 'string',
+                        'default'     => 'desc',
+                        'enum'        => array( 'asc', 'desc' ),
+                );
+
+                $query_params['orderby'] = array(
+                        'description' => __( 'Sort collection by object attribute.' ),
+                        'type'        => 'string',
+                        'default'     => 'date',
+                        'enum'        => array(
+                                'date',
+                                'id',
+                                'include',
+                                'relevance',
+                                'slug',
+                                'include_slugs',
+                                'title',
+                        ),
+                );
+
+                return $query_params;
         }
 
         /**

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

@@ -44 +44 @@
                                 'ID'           => self::$post_id,
                         )
                 );
+                wp_update_post(
+                        array(
+                                'post_content' => 'This content is fantastic.',
+                                'ID'           => self::$post_id,
+                        )
+                );
                 wp_set_current_user( 0 );
         }
 
@@ -59 +65 @@
         public function setUp() {
                 parent::setUp();
 
-                $revisions          = wp_get_post_revisions( self::$post_id );
-                $this->revision_1   = array_pop( $revisions );
-                $this->revision_id1 = $this->revision_1->ID;
-                $this->revision_2   = array_pop( $revisions );
-                $this->revision_id2 = $this->revision_2->ID;
+                $revisions             = wp_get_post_revisions( self::$post_id );
+                $this->total_revisions = count( $revisions );
+                $this->revisions       = $revisions;
+                $this->revision_1      = array_pop( $revisions );
+                $this->revision_id1    = $this->revision_1->ID;
+                $this->revision_2      = array_pop( $revisions );
+                $this->revision_id2    = $this->revision_2->ID;
+                $this->revision_3      = array_pop( $revisions );
+                $this->revision_id3    = $this->revision_3->ID;
         }
 
         public function test_register_routes() {
@@ -95 +105 @@
                 $response = rest_get_server()->dispatch( $request );
                 $data     = $response->get_data();
                 $this->assertEquals( 200, $response->get_status() );
-                $this->assertCount( 2, $data );
+                $this->assertCount( $this->total_revisions, $data );
 
                 // Reverse chron
-                $this->assertEquals( $this->revision_id2, $data[0]['id'] );
-                $this->check_get_revision_response( $data[0], $this->revision_2 );
-
-                $this->assertEquals( $this->revision_id1, $data[1]['id'] );
-                $this->check_get_revision_response( $data[1], $this->revision_1 );
+                $this->assertEquals( $this->revision_id3, $data[2]['id'] );
+                $this->check_get_revision_response( $data[2], $this->revision_3 );
+                
+                $this->assertEquals( $this->revision_id2, $data[1]['id'] );
+                $this->check_get_revision_response( $data[1], $this->revision_2 );
+
+                $this->assertEquals( $this->revision_id1, $data[0]['id'] );
+                $this->check_get_revision_response( $data[0], $this->revision_1 );
         }
 
         public function test_get_items_no_permission() {
@@ -363 +376 @@
                 $this->assertEquals( $parent_post_id, self::$post_id );
         }
 
+        /**
+         * Test the pagination header of the first page.
+         *
+         * @ticket 40510
+         */
+        public function test_get_items_pagination_header_of_the_first_page() {
+                wp_set_current_user( self::$editor_id );
+
+                $rest_route  = '/wp/v2/posts/' . self::$post_id . '/revisions';
+                $per_page    = 2;
+                $total_pages = (int) ceil( $this->total_revisions / $per_page );
+                $page        = 1;  // First page.
+
+                $request = new WP_REST_Request( 'GET', $rest_route );
+                $request->set_query_params( array(
+                        'per_page' => $per_page,
+                        'page'     => $page,
+                ));
+                $response = rest_get_server()->dispatch( $request );
+                $headers  = $response->get_headers();
+                $this->assertSame( $this->total_revisions, $headers['X-WP-Total'] );
+                $this->assertSame( $total_pages, $headers['X-WP-TotalPages'] );
+                $next_link = add_query_arg(
+                        array(
+                                'per_page' => $per_page,
+                                'page'     => $page + 1,
+                        ), rest_url( $rest_route )
+                );
+                $this->assertFalse( stripos( $headers['Link'], 'rel="prev"' ) );
+                $this->assertContains( '<' . $next_link . '>; rel="next"', $headers['Link'] );
+        }
+
+        /**
+         * Test the pagination header of the last page.
+         *
+         * @ticket 40510
+         */
+        public function test_get_items_pagination_header_of_the_last_page() {
+                wp_set_current_user( self::$editor_id );
+
+                $rest_route  = '/wp/v2/posts/' . self::$post_id . '/revisions';
+                $per_page    = 2;
+                $total_pages = (int) ceil( $this->total_revisions / $per_page );
+                $page        = 2;  // Last page.
+
+                $request = new WP_REST_Request( 'GET', $rest_route );
+                $request->set_query_params( array(
+                        'per_page' => $per_page,
+                        'page'     => $page,
+                ));
+                $response = rest_get_server()->dispatch( $request );
+                $headers  = $response->get_headers();
+                $this->assertSame( $this->total_revisions, $headers['X-WP-Total'] );
+                $this->assertSame( $total_pages, $headers['X-WP-TotalPages'] );
+                $prev_link = add_query_arg(
+                        array(
+                                'per_page' => $per_page,
+                                'page'     => $page - 1,
+                        ), rest_url( $rest_route )
+                );
+                $this->assertContains( '<' . $prev_link . '>; rel="prev"', $headers['Link'] );
+        }
+
+        /**
+         * Test that invalid 'per_page' query should error.
+         *
+         * @ticket 40510
+         */
+        public function test_get_items_invalid_per_page_should_error() {
+                wp_set_current_user( self::$editor_id );
+
+                $per_page        = -1; // Invalid number.
+                $expected_error  = 'rest_invalid_param';
+                $expected_status = 400;
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+                $request->set_param( 'per_page', $per_page );
+                $response = rest_get_server()->dispatch( $request );
+                $this->assertErrorResponse( $expected_error, $response, $expected_status );
+        }
+
+        /**
+         * Test that out of bounds 'page' query should error.
+         *
+         * @ticket 40510
+         */
+        public function test_get_items_out_of_bounds_page_should_error() {
+                wp_set_current_user( self::$editor_id );
+
+                $per_page        = 2;
+                $total_pages     = (int) ceil( $this->total_revisions / $per_page );
+                $page            = $total_pages + 1; // Out of bound page.
+                $expected_error  = 'rest_revision_invalid_page_number';
+                $expected_status = 400;
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+                $request->set_query_params( array(
+                        'per_page' => $per_page,
+                        'page'     => $page,
+                ));
+                $response = rest_get_server()->dispatch( $request );
+                $this->assertErrorResponse( $expected_error, $response, $expected_status );
+        }
+
+        /**
+         * Test that impossibly high 'page' query should error.
+         *
+         * @ticket 40510
+         */
+        public function test_get_items_invalid_max_pages_should_error() {
+                wp_set_current_user( self::$editor_id );
+
+                $per_page        = 2;
+                $page            = REST_TESTS_IMPOSSIBLY_HIGH_NUMBER; // Invalid number.
+                $expected_error  = 'rest_revision_invalid_page_number';
+                $expected_status = 400;
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+                $request->set_query_params( array(
+                        'per_page' => $per_page,
+                        'page'     => $page,
+                ));
+                $response = rest_get_server()->dispatch( $request );
+                $this->assertErrorResponse( $expected_error, $response, $expected_status );
+        }
+
+        /**
+         * Test the search query.
+         *
+         * @ticket 40510
+         */
+        public function test_get_items_search_query() {
+                wp_set_current_user( self::$editor_id );
+
+                $search_string    = 'better';
+                $expected_count   = 1;
+                $expected_content = 'This content is better.';
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+                $request->set_param( 'search', $search_string );
+                $response = rest_get_server()->dispatch( $request );
+                $data     = $response->get_data();
+                $this->assertCount( $expected_count, $data );
+                $this->assertContains( $expected_content, $data[0]['content']['rendered'] );
+        }
+
+        /**
+         * Test that the default query should fetch all revisions.
+         *
+         * @ticket 40510
+         */
+        public function test_get_items_default_query_should_fetch_all_revisons() {
+                wp_set_current_user( self::$editor_id );
+
+                $expected_count = $this->total_revisions;
+
+                $request  = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+                $response = rest_get_server()->dispatch( $request );
+                $this->assertCount( $expected_count, $response->get_data() );
+        }
+
+        /**
+         * Test that 'offset' query shouldn't work without 'per_page' (fallback -1).
+         *
+         * @ticket 40510
+         */
+        public function test_get_items_offset_should_not_work_without_per_page() {
+                wp_set_current_user( self::$editor_id );
+
+                $offset         = 1;
+                $expected_count = $this->total_revisions;
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+                $request->set_param( 'offset', $offset );
+                $response = rest_get_server()->dispatch( $request );
+                $this->assertCount( $expected_count, $response->get_data() );
+        }
+
+        /**
+         * Test that 'offset' query should work with 'per_page'.
+         *
+         * @ticket 40510
+         */
+        public function test_get_items_offset_should_work_with_per_page() {
+                wp_set_current_user( self::$editor_id );
+
+                $per_page       = 2;
+                $offset         = 1;
+                $expected_count = 2;
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+                $request->set_query_params( array(
+                        'offset'   => $offset,
+                        'per_page' => $per_page,
+                ));
+                $response = rest_get_server()->dispatch( $request );
+                $this->assertCount( $expected_count, $response->get_data() );
+        }
+
+        /**
+         * Test that 'offset' query should take priority over 'page'.
+         *
+         * @ticket 40510
+         */
+        public function test_get_items_offset_should_take_priority_over_page() {
+                wp_set_current_user( self::$editor_id );
+
+                $per_page       = 2;
+                $offset         = 1;
+                $page           = 1;
+                $expected_count = 2;
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+                $request->set_query_params( array(
+                        'offset'   => $offset,
+                        'per_page' => $per_page,
+                        'page'     => $page,
+                ));
+                $response = rest_get_server()->dispatch( $request );
+                $this->assertCount( $expected_count, $response->get_data() );
+        }
+
+        /**
+         * Test that 'offset' query, as the total revisions count, should return empty data.
+         *
+         * @ticket 40510
+         */
+        public function test_get_items_total_revisions_offset_should_return_empty_data() {
+                wp_set_current_user( self::$editor_id );
+
+                $per_page       = 2;
+                $offset         = $this->total_revisions;
+                $expected_count = 0;
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+                $request->set_query_params( array(
+                        'offset'   => $offset,
+                        'per_page' => $per_page,
+                ));
+                $response = rest_get_server()->dispatch( $request );
+                $this->assertCount( $expected_count, $response->get_data() );
+        }
+
+        /**
+         * Test that out of bound 'offset' query should error.
+         *
+         * @ticket 40510
+         */
+        public function test_get_items_out_of_bound_offset_should_error() {
+                wp_set_current_user( self::$editor_id );
+
+                $per_page        = 2;
+                $offset          = $this->total_revisions + 1;
+                $expected_error  = 'rest_revision_invalid_offset_number';
+                $expected_status = 400;
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+                $request->set_query_params( array(
+                        'offset'   => $offset,
+                        'per_page' => $per_page,
+                ));
+                $response = rest_get_server()->dispatch( $request );
+                $this->assertErrorResponse( $expected_error, $response, $expected_status );
+        }
+
+        /**
+         * Test that impossible high number for 'offset' query should error.
+         *
+         * @ticket 40510
+         */
+        public function test_get_items_impossible_high_number_offset_should_error() {
+                wp_set_current_user( self::$editor_id );
+
+                $per_page        = 2;
+                $offset          = REST_TESTS_IMPOSSIBLY_HIGH_NUMBER;
+                $expected_error  = 'rest_revision_invalid_offset_number';
+                $expected_status = 400;
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+                $request->set_query_params( array(
+                        'offset'   => $offset,
+                        'per_page' => $per_page,
+                ));
+                $response = rest_get_server()->dispatch( $request );
+                $this->assertErrorResponse( $expected_error, $response, $expected_status );
+        }
+
+        /**
+         * Test that invalid 'offset' query should error.
+         *
+         * @ticket 40510
+         */
+        public function test_get_items_invalid_offset_should_error() {
+                wp_set_current_user( self::$editor_id );
+
+                $per_page        = 2;
+                $offset          = 'moreplease';
+                $expected_error  = 'rest_invalid_param';
+                $expected_status = 400;
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/revisions' );
+                $request->set_query_params( array(
+                        'offset'   => $offset,
+                        'per_page' => $per_page,
+                ));
+                $response = rest_get_server()->dispatch( $request );
+                $this->assertErrorResponse( $expected_error, $response, $expected_status );
+        }
 }

tests/qunit/fixtures/wp-api-generated.js

@@ -718 +718 @@
                             ],
                             "description": "Scope under which the request is made; determines fields present in response.",
                             "type": "string"
+                        },
+                        "page": {
+                            "required": false,
+                            "default": 1,
+                            "description": "Current page of the collection.",
+                            "type": "integer"
+                        },
+                        "per_page": {
+                            "required": false,
+                            "description": "Maximum number of items to be returned in result set.",
+                            "type": "integer"
+                        },
+                        "search": {
+                            "required": false,
+                            "description": "Limit results to those matching a string.",
+                            "type": "string"
+                        },
+                        "exclude": {
+                            "required": false,
+                            "default": [],
+                            "description": "Ensure result set excludes specific IDs.",
+                            "type": "array",
+                            "items": {
+                                "type": "integer"
+                            }
+                        },
+                        "include": {
+                            "required": false,
+                            "default": [],
+                            "description": "Limit result set to specific IDs.",
+                            "type": "array",
+                            "items": {
+                                "type": "integer"
+                            }
+                        },
+                        "offset": {
+                            "required": false,
+                            "description": "Offset the result set by a specific number of items.",
+                            "type": "integer"
+                        },
+                        "order": {
+                            "required": false,
+                            "default": "desc",
+                            "enum": [
+                                "asc",
+                                "desc"
+                            ],
+                            "description": "Order sort attribute ascending or descending.",
+                            "type": "string"
+                        },
+                        "orderby": {
+                            "required": false,
+                            "default": "date",
+                            "enum": [
+                                "date",
+                                "id",
+                                "include",
+                                "relevance",
+                                "slug",
+                                "include_slugs",
+                                "title"
+                            ],
+                            "description": "Sort collection by object attribute.",
+                            "type": "string"
                         }
                     }
                 }
@@ -1256 +1320 @@
                             ],
                             "description": "Scope under which the request is made; determines fields present in response.",
                             "type": "string"
+                        },
+                        "page": {
+                            "required": false,
+                            "default": 1,
+                            "description": "Current page of the collection.",
+                            "type": "integer"
+                        },
+                        "per_page": {
+                            "required": false,
+                            "description": "Maximum number of items to be returned in result set.",
+                            "type": "integer"
+                        },
+                        "search": {
+                            "required": false,
+                            "description": "Limit results to those matching a string.",
+                            "type": "string"
+                        },
+                        "exclude": {
+                            "required": false,
+                            "default": [],
+                            "description": "Ensure result set excludes specific IDs.",
+                            "type": "array",
+                            "items": {
+                                "type": "integer"
+                            }
+                        },
+                        "include": {
+                            "required": false,
+                            "default": [],
+                            "description": "Limit result set to specific IDs.",
+                            "type": "array",
+                            "items": {
+                                "type": "integer"
+                            }
+                        },
+                        "offset": {
+                            "required": false,
+                            "description": "Offset the result set by a specific number of items.",
+                            "type": "integer"
+                        },
+                        "order": {
+                            "required": false,
+                            "default": "desc",
+                            "enum": [
+                                "asc",
+                                "desc"
+                            ],
+                            "description": "Order sort attribute ascending or descending.",
+                            "type": "string"
+                        },
+                        "orderby": {
+                            "required": false,
+                            "default": "date",
+                            "enum": [
+                                "date",
+                                "id",
+                                "include",
+                                "relevance",
+                                "slug",
+                                "include_slugs",
+                                "title"
+                            ],
+                            "description": "Sort collection by object attribute.",
+                            "type": "string"
                         }
                     }
                 }