Skip to content

Commit a41c53a

Browse files
author
Tyler Kellen
committed
link compound documents in non-normative note for including
1 parent f8a6bde commit a41c53a

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

format/index.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -937,11 +937,10 @@ GET /articles/1?include=comments.author HTTP/1.1
937937
Accept: application/vnd.api+json
938938
```
939939

940-
> Note: Because compound documents require full linkage, intermediate
941-
resources in a multi-part path must be returned along with the leaf nodes.
942-
For example, a response to a request for `comments.author` should
943-
automatically include `comments` as well as the `author` of each of those
944-
`comments`.
940+
> Note: Because [compound documents][compound document] require full linkage,
941+
intermediate resources in a multi-part path must be returned along with the leaf
942+
nodes. For example, a response to a request for `comments.author` should
943+
include `comments` as well as the `author` of each of those `comments`.
945944

946945
> Note: A server may choose to expose a deeply nested relationship such as
947946
`comments.author` as a direct relationship with an alias such as

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy