Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update foreign-key-relations.md

Browse Source
This commit is contained in:
Z
2017-06-26 09:45:08 +02:00
committed by GitHub
parent 74cecc9611
commit 5ea8243a5e
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
message/foreign-key-relations.md
View File

@@ -1,7 +1,7 @@
# Foreign Key Relations
## Link or Embed Foreign Key Relation
When a resource representation includes relation with another (foreign) resource the relation **MUST** be expressed as a link relation or embed the related resource.
When a resource representation includes relation with another (foreign) resource, the relation **MUST** be expressed as a link relation or embed the related resource.
#### Example
Use:
@@ -41,7 +41,7 @@ instead:
```
## Nest Foreign Key Relation
If a foreign object has another identifier but URI or the foreign object isn't a resource the object **MUST** be nested.
If a foreign object has another identifier, but URI or the foreign object isn't a resource, the object **MUST** be nested.
#### Example
Use:
@@ -64,4 +64,4 @@ instead:
}
```
> NOTE: As a rule of thumb, in a HTTP message body, there SHOULD NOT be any field with trailing "_id", "_href", "_url" etc. in its name.
> NOTE: As a rule of thumb, in an HTTP message body, there SHOULD NOT be any field with trailing "_id," "_href," "_url" etc. in its name.