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:
ianschechtman
2024-05-13 14:50:42 +02:00
committed by GitHub
parent c54fb85268
commit 3857bb4013
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
rest-api-guidelines/message/foreign-key-relations.md
View File

@@ -2,7 +2,7 @@
## Link or Embed Foreign Key Relation ## 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 a relation with another \(foreign\) resource, the relation **MUST** be expressed as a link relation or embed the related resource.
### Example ### Example
@@ -33,7 +33,7 @@ or:
} }
``` ```
instead: instead of:
```javascript ```javascript
{ {
@@ -60,7 +60,7 @@ Use:
} }
``` ```
instead: instead of:
```javascript ```javascript
{ {
@@ -68,5 +68,5 @@ instead:
} }
``` ```
> 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. > 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.