add example for multiple extensions applied #1773
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
jelhan
commented
Nov 7, 2024
Comment on lines
+96
to
+101
| In the following example, two extensions and one profile have been applied: | ||
|
|
||
| ```http | ||
| HTTP/1.1 200 OK | ||
| Content-Type: application/vnd.api+json;ext="https://example.com/version https://example.com/bulk";profile="https://example.com/resource-timestamps" | ||
| ``` |
There was a problem hiding this comment.
I wasn't sure if the example should go here or a little bit later into the Content Negotiation section. The specification addresses the topic at two places. Just before this new paragraph it defines that the value of the media type parameters is a space-separated list. But how and when the media type is used, is defined later in the section on content negotiation.
I'm not opinionated at all where we put this example.
|
Looks great, thank you! |
dgeb
approved these changes
Nov 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The question how a media type looks like if multiple extensions or profiles have been applied came up twice (#1770, #1768). It was already well defined in the specification:
This PR adds an additional example similar to the examples we have in other cases for additional clarity.
Closes #1770