Skip to content

Commit a243917

Browse files
committed
Associate "relationship object" with everything else
1 parent 95a915d commit a243917

File tree

4 files changed

+14
-12
lines changed

4 files changed

+14
-12
lines changed

_format/1.0/index.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -240,13 +240,14 @@ alongside other information to be represented in a resource object, these keys
240240
#### <a href="#document-resource-object-relationships" id="document-resource-object-relationships" class="headerlink"></a> Relationships
241241

242242
The value of the `relationships` key **MUST** be an object (a "relationships
243-
object"). Members of the relationships object ("relationships") represent
244-
references from the [resource object][resource objects] in which it's defined to other resource
245-
objects.
243+
object"). Members of the relationships object represent "relationships", i.e.,
244+
references from the [resource object][resource objects] in which they are defined
245+
to other resource objects.
246246

247247
Relationships may be to-one or to-many.
248248

249-
A "relationship object" **MUST** contain at least one of the following:
249+
Each relationship's contents **MUST** be represented by an object (a "relationship
250+
object") containing at least one of the following:
250251

251252
* `links`: a [links object][links] containing at least one of the following:
252253
* `self`: a link for the relationship itself (a "relationship link"). This
@@ -268,7 +269,7 @@ A relationship object that represents a to-many relationship **MAY** also contai
268269
269270
#### <a href="#document-resource-object-related-resource-links" id="document-resource-object-related-resource-links" class="headerlink"></a> Related Resource Links
270271

271-
A "related resource link" provides access to [resource objects] [linked][links]
272+
A "related resource link" provides access to [resource objects][] [linked][links]
272273
in a [relationship][relationships]. When fetched, the related resource object(s)
273274
are returned as the response's primary data.
274275

_format/1.0/normative-statements.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -643,7 +643,7 @@ layout: null
643643
"type": "normative-statements",
644644
"attributes": {
645645
"level": "MUST",
646-
"description": "A \"relationship object\" **MUST** contain at least one of the following:]\\n\\n- `links`: a links object containing at least one of the following:\\n - `self`: a link for the relationship itself (a \"relationship link\"). This link allows the client to directly manipulate the relationship. For example, it would allow a client to remove an author from an article without deleting the people resource itself.\\n - `related`: a related resource link\\n- `data`: resource linkage\\n- `meta`: a meta object that contains non-standard meta-information about the relationship."
646+
"description": "Each relationship's contents **MUST** be represented by an object (a \"relationship object\") containing at least one of the following:\\n\\n- `links`: a links object containing at least one of the following:\\n - `self`: a link for the relationship itself (a \"relationship link\"). This link allows the client to directly manipulate the relationship. For example, it would allow a client to remove an author from an article without deleting the people resource itself.\\n - `related`: a related resource link\\n- `data`: resource linkage\\n- `meta`: a meta object that contains non-standard meta-information about the relationship."
647647
},
648648
"relationships": {
649649
"section": {

_format/1.1/index.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -240,13 +240,14 @@ alongside other information to be represented in a resource object, these keys
240240
#### <a href="#document-resource-object-relationships" id="document-resource-object-relationships" class="headerlink"></a> Relationships
241241

242242
The value of the `relationships` key **MUST** be an object (a "relationships
243-
object"). Members of the relationships object ("relationships") represent
244-
references from the [resource object][resource objects] in which it's defined to other resource
245-
objects.
243+
object"). Members of the relationships object represent "relationships", i.e.,
244+
references from the [resource object][resource objects] in which they are defined
245+
to other resource objects.
246246

247247
Relationships may be to-one or to-many.
248248

249-
A "relationship object" **MUST** contain at least one of the following:
249+
Each relationship's contents **MUST** be represented by an object (a "relationship
250+
object") containing at least one of the following:
250251

251252
* `links`: a [links object][links] containing at least one of the following:
252253
* `self`: a link for the relationship itself (a "relationship link"). This
@@ -268,7 +269,7 @@ A relationship object that represents a to-many relationship **MAY** also contai
268269
269270
#### <a href="#document-resource-object-related-resource-links" id="document-resource-object-related-resource-links" class="headerlink"></a> Related Resource Links
270271

271-
A "related resource link" provides access to [resource objects] [linked][links]
272+
A "related resource link" provides access to [resource objects][] [linked][links]
272273
in a [relationship][relationships]. When fetched, the related resource object(s)
273274
are returned as the response's primary data.
274275

_format/1.1/normative-statements.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -643,7 +643,7 @@ layout: null
643643
"type": "normative-statements",
644644
"attributes": {
645645
"level": "MUST",
646-
"description": "A \"relationship object\" **MUST** contain at least one of the following:]\\n\\n- `links`: a links object containing at least one of the following:\\n - `self`: a link for the relationship itself (a \"relationship link\"). This link allows the client to directly manipulate the relationship. For example, it would allow a client to remove an author from an article without deleting the people resource itself.\\n - `related`: a related resource link\\n- `data`: resource linkage\\n- `meta`: a meta object that contains non-standard meta-information about the relationship."
646+
"description": "Each relationship's contents **MUST** be represented by an object (a \"relationship object\") containing at least one of the following:\\n\\n- `links`: a links object containing at least one of the following:\\n - `self`: a link for the relationship itself (a \"relationship link\"). This link allows the client to directly manipulate the relationship. For example, it would allow a client to remove an author from an article without deleting the people resource itself.\\n - `related`: a related resource link\\n- `data`: resource linkage\\n- `meta`: a meta object that contains non-standard meta-information about the relationship."
647647
},
648648
"relationships": {
649649
"section": {

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