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/reserved-identifiers.md

Browse Source 
Auto commit by GitBook Editor
This commit is contained in:
apidesigner
2017-02-21 12:03:49 +01:00
parent 8d0d805ecb
commit ddce664fd5
2 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
evolution/naming-conventions.md
View File

@@ -3,9 +3,10 @@
## General Naming Rules
- Use American English
- Use lowercase ("snake_case")
- Don't use acronyms
- Use underscore to delimit words
- Use terms from
- Use underscore to delimit words unless stated otherwise
- Use lowercase ("snake_case") 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.

5
evolution/reserved-identifiers.md
View File

@@ -1,4 +1,9 @@
# Reserved Identifiers
The list of all reserved identifiers or identifiers with special meaning.
## Representation Format Fields
- `_links` - [HAL](https://adidas-group.gitbooks.io/api-guidelines/content/message/hal.html)
- `_embedded` - [HAL](https://adidas-group.gitbooks.io/api-guidelines/content/message/hal.html)
## Query Parameters
- `fields`- [Choosing Fields & Embedded Resources](https://adidas-group.gitbooks.io/api-guidelines/content/execution/choosing-fields-and-embedded-resoruces.html)