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:34:16 +01:00
parent 0be55d10ad
commit 1aa398ca9a
1 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
evolution/naming-conventions.md
View File

@@ -12,7 +12,6 @@ Every identifier **MUST** be in `lowercase` except for abbreviations. An identif
Every URI **MUST** follow the General Rules. In addition, an URI **MUST NOT** end with a trailing slash (`/`). Every URI **MUST** follow the General Rules. In addition, an URI **MUST NOT** end with a trailing slash (`/`).
#### Example #### Example
A well-formed URI: A well-formed URI:
``` ```
@@ -28,14 +27,12 @@ In addition to General Naming Rules, URI Template Variable names **MUST** follow
> NOTE: Per RFC6570 Hyphen (`-`) is NOT legal URI Template variable name character. > NOTE: Per RFC6570 Hyphen (`-`) is NOT legal URI Template variable name character.
#### Example #### Example
A well-formed URI Template Variable: A well-formed URI Template Variable:
``` ```
/system_orders/{order_id}/author /system_orders/{order_id}/author
``` ```
## 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.
@@ -45,6 +42,8 @@ Every custom [relation identifier](https://github.com/for-GET/know-your-http-wel
## 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