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:36:09 +01:00
parent b339aa0478
commit ca0d295fe4
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
evolution/naming-conventions.md
View File

@@ -36,6 +36,25 @@ A well-formed URI Template Variable:
## Representation Format Fields ## Representation Format Fields
Every representation format field **MUST** conform to the General Naming Rules. Every representation format field **MUST** conform to the General Naming Rules.
#### Example
A well-formed resource representation:
```json
{
"_links": {
"self": {
"href": "/orders/1234"
},
"author": {
"href": "/users/john"
}
},
"order_number": 1234,
"item_count": 42,
"status": "pending"
}
```
## 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** conform to the General Naming Rules.