[jsonapi] Introduce partialSet request option#883
Merged
Conversation
The `partialSet` request option provides explicit control over whether the resultset in a successful response should be interpreted as a partial set of related records. Currently, this option only applies to requests for related records. Example usage: A request is made to a custom relationship `url` and you want the records returned to be added to the relationship, rather than to replace all existing members of that relationship. If this property is not set, then `data` will be implicitly treated as a partial set of related records if: - a `filter` option is present in the request - a `page` option is present in the request - a `prev` or `next` link is present in the response document's top-level `links` object.
dgeb
force-pushed
the
jsonapi-partial-set
branch
from
August 12, 2021 11:57
adcb825 to
855ff78
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
partialSetrequest option provides explicit control over whether the resultset in a successful response should be interpreted as a partial set of related records. Currently, this option only applies to requests for related records.Example usage: A request is made to a custom relationship
urland you want the records returned to be added to the relationship, rather than to replace all existing members of that relationship.If this property is not set, then
datawill be implicitly treated as a partial set of related records if:filteroption is present in the requestpageoption is present in the requestprevornextlink is present in the response document's top-levellinksobject.