Skip to content

Clarify relationship formatting #480

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

Merged
merged 7 commits into from
Mar 26, 2015
Merged

Clarify relationship formatting #480

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5c068fb
Clarify formatting relationships on creation
ethanresnick Mar 16, 2015
f17d17f
Apply same logic to PATCH
Mar 21, 2015
1ef7475
Minor cleanup
Mar 21, 2015
4a18aa5
Use "linkage object" definition to replace redundant descriptions
ethanresnick Mar 22, 2015
c0d2de3
Fixt typo
ethanresnick Mar 23, 2015
cdf35f9
Simpler wording for POST `linkage` note
ethanresnick Mar 23, 2015
89a6b99
Define "linkage object" in its own paragraph
ethanresnick Mar 23, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Simpler wording for POST linkage note
  • Loading branch information
@ethanresnick
ethanresnick committed Mar 23, 2015
commit cdf35f977a6e40a1be66972c0c73fc8520a74ebd
6 changes: 3 additions & 3 deletions format/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -912,9 +912,9 @@ Accept: application/vnd.api+json
}
```

If the resource object being sent contains any relationships in its `"links"`
key, those relationships **MUST** each have a `"linkage"` key that includes the
linkage the new resource is to have.
If a relationship is provided in the `links` section of the resource object, its
value **MUST** be a link object with a `linkage` member. The value of this key
represents the linkage the new resource is to have.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This phrasing seems awkward. How about keeping it similar to the note below for PATCH:

If a relationship is provided in the links section of a resource object, its value MUST be a link object with a linkage member.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated!

#### Client-Generated IDs <a href="#crud-creating-client-ids" id="crud-creating-client-ids" class="headerlink"></a>

Expand Down
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