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:33:34 +01:00
parent 4e5db71261
commit 0be55d10ad
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
evolution/naming-conventions.md
View File

@@ -11,6 +11,14 @@ Every identifier **MUST** be in `lowercase` except for abbreviations. An identif
## URI
Every URI **MUST** follow the General Rules. In addition, an URI **MUST NOT** end with a trailing slash (`/`).
#### Example
A well-formed URI:
```
/system_orders/1234/author
```
### Query Parameters and Path Fragments
Every URI query parameter or fragment **MUST** follow the General Rules. In addition, they **MUST NOT** clash with the [reserved query parameter names](https://tools.adidas-group.com/confluence/display/EA/API+Interaction#APIInteraction-Query_Parameters).
@@ -19,6 +27,15 @@ In addition to General Naming Rules, URI Template Variable names **MUST** follow
> NOTE: Per RFC6570 Hyphen (`-`) is NOT legal URI Template variable name character.
#### Example
A well-formed URI Template Variable:
```
/system_orders/{order_id}/author
```
## Representation Format Fields
Every representation format field **MUST** conform to the General Naming Rules.