Simplify profiles for v1.1 #1456
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
…led documents. - Ignoring document members is not necessary for profiles since they can no longer add new members to reserved areas of the specification. - Clients should not need to resend unprofiled documents because servers should be able to ignore profiles.
… client responsibilities.
|
@dgeb and I reviewed this together. This has been open for a week without comment. Merging... |
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.
This PR makes progress on the move to simplify profiles for v1.1 of the spec, as outlined in #1435.
This continues work that's been merged already to unify profile negotiation. PR #1413 changed profiles to be purely opt-in by the server to align with RFC 6906.
This PR makes the following additional changes:
Removes the ability for profiles to assign meaning to reserved query params such as
filterandpage. RFC 6906 states that "A profile MUST NOT change the semantics of the resource representation when processed without profile knowledge, so that clients both with and without knowledge of a profiled resource can safely use the same representation.". Since these params are intended to provide processing instructions, they are inappropriate for profiles.Moves profile authoring guidelines out of the base spec and into the non-normative recommendations page.
Removes guarantees about profile registration and publication on jsonapi.org.