Return user schema and request args in body of OPTIONs request #1262

danielbachhuber · 2015-05-19T22:59:03Z

danielbachhuber · 2015-05-19T22:59:55Z

lib/endpoints/class-wp-rest-users-controller.php

This repeat declaration of schema isn't great. Better ideas?

Can't we register the schema on the route rather than each endpoint?

Like this:

register_rest_route( 'wp/v2', '/posts', array( array( ... ) ), false, array( 'schema' => $schema ) );

Let's not add more parameters to register_rest_route. Can we just add it to the existing route stuff?

register_rest_route( 'wp/v2', '/comments', array( array( 'methods' => WP_REST_Server::READABLE, ... ), array( 'methods' => WP_REST_Server::CREATABLE, ... ), 'schema' => ... ) );

(Similar to meta queries with relation mixed with the indexed arrays)

danielbachhuber · 2015-05-19T23:02:37Z

@joehoyle Would love your input on this. The abstraction seems a bit messy at the moment.

danielbachhuber · 2015-05-20T23:43:39Z

Response looks a bit like this right now:

{
  "request_args": {
    "GET": {
      "page": {
        "description": "Current page of the collection.",
        "type": "integer",
        "default": 1,
        "sanitize_callback": "absint"
      },
      "per_page": {
        "description": "Maximum number of items to be returned in result set.",
        "type": "integer",
        "default": 10,
        "sanitize_callback": "absint"
      },
      "search": {
        "description": "Limit results to those matching a string.",
        "type": "string",
        "sanitize_callback": "sanitize_text_field"
      },
      "context": {
        "default": "view",
        "description": "Change the response format based on request context.",
        "enum": [
          "view",
          "edit"
        ],
        "sanitize_callback": "sanitize_key",
        "type": "string"
      },
      "order": {
        "default": "asc",
        "description": "Order sort attribute ascending or descending.",
        "enum": [
          "asc",
          "desc"
        ],
        "sanitize_callback": "sanitize_key",
        "type": "string"
      },
      "orderby": {
        "default": "name",
        "description": "Sort collection by object attribute.",
        "enum": [
          "id",
          "name",
          "registered_date"
        ],
        "sanitize_callback": "sanitize_key",
        "type": "string"
      }
    },
    "POST": {
      "capabilities": [],
      "description": [],
      "email": {
        "required": true
      },
      "first_name": [],
      "last_name": [],
      "name": [],
      "nickname": [],
      "roles": [],
      "slug": [],
      "username": {
        "required": true
      },
      "password": {
        "required": true
      }
    }
  },
  "schema": {
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "user",
    "type": "object",
    "properties": {
      "avatar_url": {
        "description": "Avatar URL for the object.",
        "type": "string",
        "format": "uri",
        "context": [
          "embed",
          "view",
          "edit"
        ],
        "readonly": true
      },
      "capabilities": {
        "description": "All capabilities assigned to the user.",
        "type": "object",
        "context": [
          "view",
          "edit"
        ]
      },
      "description": {
        "description": "Description of the object.",
        "type": "string",
        "context": [
          "embed",
          "view",
          "edit"
        ]
      },
      "email": {
        "description": "The email address for the object.",
        "type": "string",
        "format": "email",
        "context": [
          "view",
          "edit"
        ],
        "required": true
      },
      "extra_capabilities": {
        "description": "Any extra capabilities assigned to the user.",
        "type": "object",
        "context": [
          "edit"
        ],
        "readonly": true
      },
      "first_name": {
        "description": "First name for the object.",
        "type": "string",
        "context": [
          "embed",
          "view",
          "edit"
        ]
      },
      "id": {
        "description": "Unique identifier for the object.",
        "type": "integer",
        "context": [
          "embed",
          "view",
          "edit"
        ],
        "readonly": true
      },
      "last_name": {
        "description": "Last name for the object.",
        "type": "string",
        "context": [
          "embed",
          "view",
          "edit"
        ]
      },
      "link": {
        "description": "Author URL to the object.",
        "type": "string",
        "format": "uri",
        "context": [
          "embed",
          "view",
          "edit"
        ],
        "readonly": true
      },
      "name": {
        "description": "Display name for the object.",
        "type": "string",
        "context": [
          "embed",
          "view",
          "edit"
        ]
      },
      "nickname": {
        "description": "The nickname for the object.",
        "type": "string",
        "context": [
          "embed",
          "view",
          "edit"
        ]
      },
      "registered_date": {
        "description": "Registration date for the user.",
        "type": "date-time",
        "context": [
          "view",
          "edit"
        ],
        "readonly": true
      },
      "roles": {
        "description": "Roles assigned to the user.",
        "type": "array",
        "context": [
          "view",
          "edit"
        ]
      },
      "slug": {
        "description": "An alphanumeric identifier for the object unique to its type.",
        "type": "string",
        "context": [
          "embed",
          "view",
          "edit"
        ]
      },
      "url": {
        "description": "URL of the object.",
        "type": "string",
        "format": "uri",
        "context": [
          "embed",
          "view",
          "edit"
        ],
        "readonly": true
      },
      "username": {
        "description": "Login name for the user.",
        "type": "string",
        "context": [
          "edit"
        ],
        "required": true
      }
    }
  }
}

danielbachhuber · 2015-05-21T23:04:44Z

@joehoyle Could you weigh in on this? Thanks

joehoyle · 2015-05-21T23:16:55Z

plugin.php

Why is this cast to an object? Pretty much everything else return an array / ArrayAccess

Because I want to make sure it's always an object, even when empty. Otherwise it will be an array when empty.

How would it be empty, per https://github.com/WP-API/WP-API/pull/1262/files#diff-55d3bf5e833c76ee6e3c2f4be15fa1cdR577 ?

Oh. Derp. I guess it was empty at one point, and then I changed my code.

joehoyle · 2015-05-21T23:22:18Z

Implementation is ok I think - though don't like the repeated schema so much - as I think there should only be one schema per route.

By using GET / POST what do we do when someone uses WP_REST_Server::UPDATABLE as that technically supports PUT and POST I believe.

rmccue · 2015-05-24T01:21:30Z

So, question: if you don't already know how to form the URL, how do you get the schema for it? For example, posts/{id}; how do I get the schema for that? Kind of annoying.

(Working with a few others on porting the dotcom console and noticed this one.)

danielbachhuber · 2015-05-25T23:42:45Z

Some discussion in Slack.

Consensus is to chuck everything into the index, as well as return it for OPTIONS on the endpoint.

Rather than just spewing out the raw data (and causing json_encode to be called on the Controller objects), this whitelists certain pieces of data.

rmccue · 2015-05-28T11:30:41Z

Splitting the index part out to #1305 so we can ship this sucker.

@WP-API/amigos #reviewmerge

rachelbaker · 2015-05-28T12:01:12Z

Punting to b3 to get passing tests.

rmccue · 2015-05-28T12:07:52Z

Punting to b3 to get passing tests.

(Also, because as pointed out, this really only affects user endpoints, and we should probably tackle them all.)

rachelbaker · 2015-09-29T12:43:54Z

@danielbachhuber,

I believe this has been taken care of in #1415

danielbachhuber · 2015-11-30T18:27:26Z

This has since been addressed.

Return user schema and request args in body of OPTIONs request

957cb9f

danielbachhuber added this to the 2.0 Beta 2 milestone May 19, 2015

danielbachhuber added the Enhancement label May 19, 2015

danielbachhuber self-assigned this May 19, 2015

danielbachhuber reviewed May 19, 2015
View reviewed changes

danielbachhuber added 2 commits May 21, 2015 16:02

Merge branch 'develop' into 1222-user-options-body

bd2ece2

Fix coding standards violations

83cc548

joehoyle reviewed May 21, 2015
View reviewed changes

rmccue mentioned this pull request May 25, 2015

List namespaces in the index #1283

Merged

rmccue added 6 commits May 28, 2015 17:01

Merge branch 'develop' into 1222-user-options-body

67df600

Correct some whitespace

9b81060

Register the schema on the route, not the endpoints

a7e3746

request_args -> args

77f3556

Fix alignment

2ced88d

Format endpoint arguments properly

796400b

Rather than just spewing out the raw data (and causing json_encode to be called on the Controller objects), this whitelists certain pieces of data.

rmccue mentioned this pull request May 28, 2015

Add schema data to the index(es) #1305

Closed

rachelbaker modified the milestones: 2.0 Beta 3, 2.0 Beta 2 May 28, 2015

danielbachhuber closed this Nov 30, 2015

danielbachhuber removed this from the 2.0 Beta 3 milestone Nov 30, 2015

danielbachhuber deleted the 1222-user-options-body branch January 11, 2016 14:32

Return user schema and request args in body of OPTIONs request #1262

Return user schema and request args in body of OPTIONs request #1262

Uh oh!

Conversation

danielbachhuber commented May 19, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

danielbachhuber commented May 19, 2015

Uh oh!

danielbachhuber commented May 20, 2015

Uh oh!

danielbachhuber commented May 21, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joehoyle commented May 21, 2015

Uh oh!

rmccue commented May 24, 2015

Uh oh!

danielbachhuber commented May 25, 2015

Uh oh!

rmccue commented May 28, 2015

Uh oh!

rachelbaker commented May 28, 2015

Uh oh!

rmccue commented May 28, 2015

Uh oh!

rachelbaker commented Sep 29, 2015

Uh oh!

danielbachhuber commented Nov 30, 2015

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants