Skip to content

Commit f7dadf5

Browse files
jelhanbeauby
andauthored
Clarify that full linkage graph must be rooted in primary data (json-api#1541)
* Clarify full linkage. * target v1.1 and improve wording * Update with Gabe Sullice's proposal Co-authored-by: Lucas Hosseini <lucas.hosseini@gmail.com>
1 parent 835d6a6 commit f7dadf5

File tree

1 file changed

+5
-9
lines changed

1 file changed

+5
-9
lines changed

_format/1.1/index.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -607,19 +607,15 @@ requested primary resources. Such responses are called "compound documents".
607607
In a compound document, all included resources **MUST** be represented as an
608608
array of [resource objects] in a top-level `included` member.
609609

610-
Compound documents require "full linkage", meaning that every included
611-
resource **MUST** be identified by at least one [resource identifier object]
612-
in the same document. These resource identifier objects could either be
613-
primary data or represent resource linkage contained within primary or
614-
included resources.
610+
Every included resource object **MUST** be identified via a chain of
611+
relationships originating in a document's primary data. This means that
612+
compound documents require "full linkage" and that no resource object can be
613+
included without a direct or indirect relationship to the document's primary
614+
data.
615615

616616
The only exception to the full linkage requirement is when relationship fields
617617
that would otherwise contain linkage data are excluded via [sparse fieldsets](#fetching-sparse-fieldsets).
618618

619-
> Note: Full linkage ensures that included resources are related to either
620-
the primary data (which could be [resource objects] or [resource identifier
621-
objects][resource identifier object]) or to each other.
622-
623619
A complete example document with multiple included relationships:
624620

625621
```json

0 commit comments

Comments
 (0)