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:52:37 +01:00
parent 0538402fbb
commit d8862f6120
1 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
evolution/naming-conventions.md
View File

@@ -94,9 +94,20 @@ Naming conventions within API Description document.
### API Name ### 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. 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.
```yaml
swagger: '2.0'
info:
version: '1.0.0'
title: '[Demo] Orders API'
```
### Resource Name ### Resource Name
Resource name **MUST** use (`Title Case`). Words **MUST** be separated by a space. Every resource **MUST** have a name (defined by `x-summary` field). Resource name **MUST** be in `Title Case`. Words **MUST** be separated by a space.
```yaml
/orders:
x-summary: List of Orders
```
### Action Name ### Action Name
Action (operation) name **MUST** use (`Title Case`). Words **MUST** be separated by a space. Action (operation) name **MUST** use (`Title Case`). Words **MUST** be separated by a space.