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/json.md

Browse Source 
Auto commit by GitBook Editor
This commit is contained in:
apidesigner
2017-06-19 09:04:39 +00:00
parent ab87b47e28
commit a44649d49e
1 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
evolution/json.md
View File

@@ -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": []`)