From d8862f6120ed82999453903e379302b4a64bee06 Mon Sep 17 00:00:00 2001 From: apidesigner Date: Mon, 20 Feb 2017 10:52:37 +0100 Subject: [PATCH] Updates evolution/naming-conventions.md Auto commit by GitBook Editor --- evolution/naming-conventions.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/evolution/naming-conventions.md b/evolution/naming-conventions.md index 9591534..c8e669f 100644 --- a/evolution/naming-conventions.md +++ b/evolution/naming-conventions.md @@ -94,9 +94,20 @@ 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. +```yaml +swagger: '2.0' +info: + version: '1.0.0' + title: '[Demo] Orders API' +``` ### 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 (operation) name **MUST** use (`Title Case`). Words **MUST** be separated by a space.