Changeset 39250

Timestamp:

11/15/2016 06:15:30 PM (8 years ago)

Author:

joehoyle

Message:

REST API: Clean up argument and property types.

There's a couple of places where we were missing type notes for arguments, which mainly affects documentation.

Props jnylen0.
Fixes #38792.

Location:

trunk/src/wp-includes/rest-api/endpoints

Files:

• class-wp-rest-comments-controller.php (modified) (1 diff)
• class-wp-rest-post-types-controller.php (modified) (1 diff)
• class-wp-rest-posts-controller.php (modified) (2 diffs)
• class-wp-rest-taxonomies-controller.php (modified) (1 diff)
• class-wp-rest-users-controller.php (modified) (3 diffs)

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

@@ -1159 +1159 @@
                             'type'            => 'string',
                             'context'         => array( 'view', 'edit', 'embed' ),
+                            'readonly'        => true,
                         ),
                     ),

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

@@ -206 +206 @@
                 'capabilities'     => array(
                     'description'  => __( 'All capabilities used by the resource.' ),
-                    'type'         => 'array',
-                    'items'        => array(
-                        'type' => 'string',
-                    ),
+                    'type'         => 'object',
                     'context'      => array( 'edit' ),
                     'readonly'     => true,

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

@@ -87 +87 @@
                     'password' => array(
                         'description' => __( 'The password for the post if it is password protected.' ),
+                        'type'        => 'string',
                     ),
                 ),
@@ -2070 +2071 @@
             'description'       => __( 'Limit result set to posts with one or more specific slugs.' ),
             'type'              => 'array',
+            'items'             => array(
+                'type'          => 'string',
+            ),
             'sanitize_callback' => 'wp_parse_slug_list',
         );

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

@@ -237 +237 @@
                 'capabilities'     => array(
                     'description'  => __( 'All capabilities used by the resource.' ),
-                    'type'         => 'array',
+                    'type'         => 'object',
                     'context'      => array( 'edit' ),
                     'readonly'     => true,

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

@@ -90 +90 @@
                         'description' => __( 'Required to be true, as resource does not support trashing.' ),
                     ),
-                    'reassign' => array(),
+                    'reassign' => array(
+                        'type'        => 'integer',
+                        'description' => __( 'Reassign the deleted user\'s posts and links to this user ID.' ),
+                    ),
                 ),
             ),
@@ -101 +104 @@
                 'callback'            => array( $this, 'get_current_item' ),
                 'args'                => array(
-                    'context'          => array(),
+                    'context' => $this->get_context_param( array( 'default' => 'view' ) ),
                 ),
             ),
@@ -120 +123 @@
                         'description' => __( 'Required to be true, as resource does not support trashing.' ),
                     ),
-                    'reassign' => array(),
+                    'reassign' => array(
+                        'type'        => 'integer',
+                        'description' => __( 'Reassign the deleted user\'s posts and links to this user ID.' ),
+                    ),
                 ),
             ),