First try at adding links to responses. #22
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
rmccue requested changes Mar 27, 2018
| | ||
| | ||
| ## Adding Links to the API Response | ||
| WordPress generates a list of links associated with the queried resource to make it easier to navigate to related resources. The `embeddable` attribute controls whether the linked resource appears in the `_embedded` section of the repsonse. |
There was a problem hiding this comment.
I'd split the embeddable bit to later on and describe links by themselves first. I'd also probably note something like "links are sent to the client as the _links property of the JSON object, but are stored separately internally from the response data"
| ) ); | ||
| ``` | ||
| | ||
| The link relation MUST be either a [registered link relation from the IANA](https://www.iana.org/assignments/link-relations/link-relations.xhtml) or a URL that is under your control. |
| | ||
| ```php | ||
| <?php | ||
| $response->add_link( 'author', rest_url( "/wp/v2/users/{$post->post_author}" ), array( |
There was a problem hiding this comment.
I'd have these without embeddable for the first examples
- Move embeddable section later. - Make clear you can't access or modify links from the response data directly. - URL → URI
| @rmccue Updated. |
| @rmccue Bumped |
kadamwhite approved these changes May 10, 2018
| | ||
| ```php | ||
| <?php | ||
| function my_plugin_prefix_register_curie( $curies ) { |
There was a problem hiding this comment.
Needs a line in the example showing the actual filter registration.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
This is a first try at adding info about modifying responses to include custom links.