From c69115b7bc1a912d2712929f3b2fa2baec20474c Mon Sep 17 00:00:00 2001 From: apidesigner Date: Mon, 20 Feb 2017 10:19:25 +0100 Subject: [PATCH] Updates evolution/naming-conventions.md Auto commit by GitBook Editor --- evolution/naming-conventions.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/evolution/naming-conventions.md b/evolution/naming-conventions.md index b695968..9e66340 100644 --- a/evolution/naming-conventions.md +++ b/evolution/naming-conventions.md @@ -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 +