mirror of
https://github.com/adidas/api-guidelines.git
synced 2025-10-25 15:19:19 +00:00
Updates evolution/naming-conventions.md
Auto commit by GitBook Editor
This commit is contained in:
@@ -110,7 +110,17 @@ Every resource **MUST** have a name (defined by `x-summary` field). Resource nam
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Action Name
|
### Action Name
|
||||||
Action (operation) name **MUST** use (`Title Case`). Words **MUST** be separated by a space.
|
Every action (operation) **MUST** have a name (defined by `x-summary` field). Resource name **MUST** be in `Title Case`. Words **MUST** be separated by a space.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
get:
|
||||||
|
summary: Retrieve list of Orders
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: The list of Orders
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/hal_orders'
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user