mirror of
https://github.com/adidas/api-guidelines.git
synced 2025-10-25 15:19:19 +00:00
Updates evolution/naming-conventions.md
Auto commit by GitBook Editor
This commit is contained in:
@@ -56,13 +56,36 @@ A well-formed resource representation:
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Relation Type Identifier
|
## 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
|
## 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)).
|
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
|
#### Example
|
||||||
|
|
||||||
|
```
|
||||||
|
ORDER-METADATA-HEADER: 42
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user