Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify that full linkage graph must be rooted in primary data #1541

Merged
merged 3 commits into from Apr 16, 2021
Merged

Clarify that full linkage graph must be rooted in primary data #1541

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
96fd707
Clarify full linkage.
beauby Apr 27, 2016
b1adfe8
target v1.1 and improve wording
jelhan Feb 20, 2021
6ff1fbf
Update with Gabe Sullice's proposal
jelhan Apr 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 5 additions & 9 deletions _format/1.1/index.md
View file
Open in desktop
Expand Up @@ -607,19 +607,15 @@ requested primary resources. Such responses are called "compound documents".
In a compound document, all included resources **MUST** be represented as an
array of [resource objects] in a top-level `included` member.

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

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

> Note: Full linkage ensures that included resources are related to either
the primary data (which could be [resource objects] or [resource identifier
objects][resource identifier object]) or to each other.

A complete example document with multiple included relationships:

```json
Expand Down