WP-API JS Client: Settings is incorrectly registered as a collection

[adamsilverstein]

Similar to the me endpoint, /wp/v2/settings is a model, not a collection. This is incorrectly detected due to the JS code assuming anything not ending with a regex is a collection, which is not true.

Potentially, we need to change the API to better expose what is and isn't a collection to the JS. The schema in the returned OPTIONS currently indicates that the response is an object, whereas it's actually a list of objects. If we change this, we need to look carefully at how we retrofit this, as changing it may break compatibility.

We should discuss how best to expose collections vs models via the API. Changing the schema is the best way, I think. See ​WP-API/proposals#2 for that discussion.

In the meantime, we should special-case /settings as well.

[adamsilverstein]

In 41056.diff​:

• Correct handling for the settings endpoint as a model
• Enable passing the 'words' for the regex test that differentiate between models and collections
• Add me/settings to the unit tests.

[kadamwhite]

@adamsilverstein Reviewed. In general it looks good; in lieu of a better way to clearly explain how we want an endpoint to be treated, this seems like a straightforward solution. One naming nitpick, I'd suggest modelEndpoints instead of singleModels as I feel it's a little more descriptive. If I see singleModels I would want to know what other kinds of models there are, vs understanding that this is a model and not a collection.

[adamsilverstein]

@kadamwhite thanks for the feedback, I like your naming suggestion. I will work on an updated patch.

[adamsilverstein]

in 41056.2.diff​

• use modelEndpoints as the variable name for the endpoints that are models.

[kadamwhite]

Refreshed patch looks good to me

[kadamwhite]

In 41112:

WP-API JS Client: Interpret Settings resource as a model.

The REST API does not provide a mechanism to distinguish between endpoints representing models and those representing collections, so the Backbone client must make that distinction internally. Previously wp-api.js accounted for /users/me, but not for /settings. This patch updates the logic so that /settings is properly registered as a Backbone model.

When calling wp.api.init, additional endpoints can be specified to be models using the modelEndpoints argument.

Props @adamsilverstein.
Fixes #41056.

[westonruter]

Re-opening for 4.8.1

[westonruter]

In 41126:

WP-API JS Client: Interpret Settings resource as a model.

The REST API does not provide a mechanism to distinguish between endpoints representing models and those representing collections, so the Backbone client must make that distinction internally. Previously wp-api.js accounted for /users/me, but not for /settings. This patch updates the logic so that /settings is properly registered as a Backbone model.

When calling wp.api.init, additional endpoints can be specified to be models using the modelEndpoints argument.

Merges [41112] onto 4.8 branch.
Props adamsilverstein, kadamwhite.
Fixes #41056 for 4.8.1.