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 evolution/naming-conventions.md

Browse Source 
Auto commit by GitBook Editor
This commit is contained in:
apidesigner
2017-02-20 10:41:04 +01:00
parent ca0d295fe4
commit e2af6973f4
1 changed files with 24 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
evolution/naming-conventions.md
View File

@@ -56,13 +56,36 @@ A well-formed resource representation:
```
## Relation Type Identifier
Every custom [relation identifier](https://github.com/for-GET/know-your-http-well/blob/master/relations.md) **MUST** conform to the General Naming Rules.
Every custom [relation identifier](https://github.com/for-GET/know-your-http-well/blob/master/relations.md) **MUST** be in `lowercase` with words separated by hyphen (`-`).
#### Example
A well-formed resource representation with custom relation `fulfillment-provider`:
```json
{
"_links": {
"self": {
"href": "/orders/1234"
},
"fulfillment-provider": {
"href": "/users/natalie"
}
},
"order_number": 1234,
"item_count": 42,
"status": "pending"
}
```
## HTTP Headers
Every HTTP Header should use `Hyphenated-Pascal-Case`. A custom HTTP Header **SHOULD NOT** start with `X-` ([RFC6648](https://tools.ietf.org/html/rfc6648)).
#### Example
```
ORDER-METADATA-HEADER: 42
```