jmespath support to limit responses

[elyobo]

Feature request -

The documentation sensibly suggests that users avoid modifying standard responses to avoid problems when using other clients that expect those fields to be present. The AWS CLI supports this with the --query argument which makes use of JMESPath (PHP library) to allow clients to better filter the data that they want without modifying the underlying data format (the standard format would remain for other clients).

Implementing support for this in the REST plugin would reduce the need for users to remove fields from the data. If there is an appropriate filter that fires just before the rest API sends the response then this could easily be packaged into a plugin as well.

[rmccue]

See #572. We're unlikely to add this to the main plugin right now, as this is plugin territory for now.

You can use either the rest_post_dispatch or rest_pre_serve_request filters for this, depending on what you want to do.

[elyobo]

Thanks for the pointers.

[elyobo]

Proof of concept at https://github.com/elyobo/wp-rest-jmespath

[elyobo]

If you have any feedback let me know, otherwise please add it to the list of compatible plugins.

[rmccue]

Awesome! If you pop us a pull request on the docs repo with the description you'd like, happy to add that for you :)

[elyobo]

Thanks @rmccue PR added at WP-API/docs-v2#126 now that the plugin is published on wp.org.