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:58:17 +01:00
parent 74b788fef2
commit 747e695d42
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
evolution/naming-conventions.md
View File

@@ -94,6 +94,8 @@ 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.
#### Example
```yaml ```yaml
swagger: '2.0' swagger: '2.0'
info: info:
@@ -104,6 +106,7 @@ info:
### Resource Name ### Resource Name
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. 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.
#### Example
```yaml ```yaml
/orders: /orders:
x-summary: List of Orders x-summary: List of Orders
@@ -112,6 +115,7 @@ Every resource **MUST** have a name (defined by `x-summary` field). Resource nam
### Action Name ### Action Name
Every action (operation) **MUST** have a name (defined by `summary` field). Resource name **MUST** be in `Title Case`. Words **MUST** be separated by a space. Every action (operation) **MUST** have a name (defined by `summary` field). Resource name **MUST** be in `Title Case`. Words **MUST** be separated by a space.
#### Example
```yaml ```yaml
get: get:
summary: Retrieve List of Orders summary: Retrieve List of Orders