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:
@@ -1,4 +1,24 @@
|
|||||||
# Naming Conventions
|
# Naming Conventions
|
||||||
_TODO_
|
|
||||||
|
|
||||||
In the interim see <https://tools.adidas-group.com/confluence/display/EA/API+Naming+Conventions>
|
## General Rules
|
||||||
|
- Use lowercase
|
||||||
|
- Don't use acronyms
|
||||||
|
- Avoid trailing slashes
|
||||||
|
- Use underscore to delimit 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.
|
||||||
|
|
||||||
|
### Query Parameters and Fragments
|
||||||
|
Every URI query parameter or fragment MUST be in **lowercase**.
|
||||||
|
|
||||||
|
### URI Template Variables
|
||||||
|
|
||||||
|
### Query Parameters
|
||||||
|
## Representation Format Fields
|
||||||
|
|
||||||
|
## Relation Type Identifier
|
||||||
|
|
||||||
|
## HTTP Headers
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user