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-02-20 10:50:38 +01:00
parent e2af6973f4
commit 0538402fbb
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
evolution/naming-conventions.md
View File

@@ -88,4 +88,18 @@ ORDER-METADATA-HEADER: 42
``` ```
## API Description
Naming conventions within API Description document.
### API Name
Every API Description API name **MUST** start with API domain enclosed in square brackets (e.g. `[API Domain] My API`). Words **MUST** be separated by space.
### Resource Name
Resource name **MUST** use (`Title Case`). Words **MUST** be separated by a space.
### Action Name
Action (operation) name **MUST** use (`Title Case`). Words **MUST** be separated by a space.