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-02-27 10:23:18 +00:00
parent 7abd7a3c99
commit a8e010e204
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
evolution/json.md
View File

@@ -1,6 +1,11 @@
# JSON Format Conventions # JSON Format Conventions
Any JSON-based message **MUST** conform to the rules outlined in this section. Any JSON-based message **MUST** conform to these rules
## Follow the Naming Conventions - 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.)
All JSON fields MUST follow the [Naming Conventions]() (use `snake_case`, US. 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": []`)