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:19:25 +01:00
parent ce26000fd7
commit c69115b7bc
1 changed files with 16 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
evolution/naming-conventions.md
View File

@@ -1,20 +1,27 @@
# Naming Conventions
## General Rules
- Use lowercase
- Don't use acronyms
- Avoid trailing slashes
- Use underscore to delimit words
## General Naming Rules
* Use lowercase
* Don't use acronyms
* Avoid trailing slashes
* Use underscore to delimit words
Every identifier **MUST** be in `lowercase` except for abbreviations. Abbreviations **MAY** be in `UPPERCASE`. An identifier **SHOULD NOT** contain acronyms. Underscore (`_`) **MUST** be used to delimit combined words.
## URI
Every URI MUST be in in **lowercase** except for abbreviations. Abbreviations **MAY** be in **uppercase**. A URI **SHOULD NOT** contain acronyms. An URI **MUST NOT** end with a trailing slash. Underscore **MUST** be used to delimit combined words.
Every URI **MUST** follow the General Rules. In addition, an URI **MUST NOT** end with a trailing slash (`/`).
### Query Parameters and Fragments
Every URI query parameter or fragment MUST be in **lowercase**.
### 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).
### URI Template Variables
In addition to General Naming Rules, URI Template Variable names **MUST** follow the [RFC6570](https://tools.ietf.org/html/rfc6570#section-2.3). That is, the variable names can consist only from `ALPHA / DIGIT / "_" / pct-encoded`.
> NOTE: Per RFC6570 Hyphen (`-`) is NOT legal URI Template variable name character.
### Query Parameters
## Representation Format Fields
## Relation Type Identifier
@@ -22,3 +29,4 @@ Every URI query parameter or fragment MUST be in **lowercase**.
## HTTP Headers