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-06-23 07:11:26 +00:00
parent 7afd71f021
commit 8f545b95c9
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
evolution/json.md
View File

@@ -1,7 +1,7 @@
# JSON Format Conventions # JSON Format Conventions
Any JSON-based message **MUST** conform to the following rules: Any JSON-based message **MUST** conform to the following rules:
1. All JSON field names **MUST** follow the [Naming Conventions](https://adidas-group.gitbooks.io/api-guidelines/content/evolution/naming-conventions.html) (`snake_case`, American English etc.) 1. All JSON field names **MUST** follow the [Naming Conventions](https://adidas-group.gitbooks.io/api-guidelines/content/evolution/naming-conventions.html) (`camelCase`, American English etc.)
1. Field names **MUST** be ASCII alpha num characters, underscore (`_`) or dollar sign (`$`) 1. Field names **MUST** be ASCII alpha num characters, underscore (`_`) or dollar sign (`$`)
1. Boolean fields **MUST NOT** be of `null` value 1. Boolean fields **MUST NOT** be of `null` value
1. Fields with `null` value **SHOULD** be omitted 1. Fields with `null` value **SHOULD** be omitted

10
evolution/naming-conventions.md
View File

@@ -6,18 +6,18 @@
- Don't use acronyms - Don't use acronyms
- Reconcile terms with adidas GDM - Reconcile terms with adidas GDM
- Use underscore to delimit words unless stated otherwise - Use underscore to delimit words unless stated otherwise
- Use lowercase ("snake_case") unless stated otherwise - Use lowercase ("camelCase") unless stated otherwise
Every identifier **MUST** be in American English and written in `lowercase`. An identifier **SHOULD NOT** contain acronyms. Underscore (`_`) **MUST** be used to delimit combined words. Every identifier **MUST** be in American English and written in `lowercase`. An identifier **SHOULD NOT** contain acronyms. CamelCase (`camelCase`) **MUST** be used to delimit combined words.
## URI ## URI
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 except for the `camelCase` rule. Instead, a hyphen (`-`) **SHOULD** be used to delimit combined words. In addition, an URI **MUST NOT** end with a trailing slash (`/`).
#### Example #### Example
A well-formed URI: A well-formed URI:
``` ```
/system_orders/1234/author /system-orders/1234/author
``` ```
### Query Parameters and Path Fragments ### Query Parameters and Path Fragments
@@ -32,7 +32,7 @@ In addition to General Naming Rules, URI Template Variable names **MUST** follow
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