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

Updates message/hal.md

Browse Source 
Auto commit by GitBook Editor
This commit is contained in:
apidesigner
2017-06-19 09:01:32 +00:00
parent 42be9d815d
commit 3961b92802
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
message/hal.md
View File

@@ -26,13 +26,13 @@ A document representing a "Greeting" resource might look like:
}
}
```
The field `_links` has a special meaning in HAL. It denotes a list of link relations - a pair if a relation identifier and a link (URI).
The field `_links` has a special meaning in HAL. It denotes a list of link relations - a pair of a relation identifier and a link (URI).
These link relations are used to express the relation of a resource with other resources.
In our case the "Greeting" resource isn't related to other resources but itself-hence the `self` relation pointing to the Greeting resource.
In our case the "Greeting" resource isn't related to other resources but itself, hence the `self` relation pointing to the Greeting resource.
It is **customary** for every resource representation to include the `self` link relation.
> NOTE: It is **customary** for every resource representation to include the `self` link relation.
> NOTE: The href **MUST** always be **relative path to the API root** (e.g. without the host and scheme).