diff --git a/evolution/json.md b/evolution/json.md index cbb30dd..74a87ab 100644 --- a/evolution/json.md +++ b/evolution/json.md @@ -1,11 +1,10 @@ # JSON Format Conventions -Any JSON-based message **MUST** conform to these rules +Any JSON-based message **MUST** conform to the following rules: - -- 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.) -- Field names **MUST** be ASCII alpha num characters, underscore (`_`) or dollar sign (`$`) -- Boolean fields **MUST NOT** be of `null` value -- Fields with `null` value **SHOULD** be omitted -- Empty arrays and objects **SHOULD NOT ** be `null` (use `[]` or `{}` instead) -- Array field names **SHOULD** be plural (e.g. `"orders": []`) +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. Field names **MUST** be ASCII alpha num characters, underscore (`_`) or dollar sign (`$`) +1. Boolean fields **MUST NOT** be of `null` value +1. Fields with `null` value **SHOULD** be omitted +1. Empty arrays and objects **SHOULD NOT ** be `null` (use `[]` or `{}` instead) +1. Array field names **SHOULD** be plural (e.g. `"orders": []`)