From 747e695d42a6198a5735823a196ae48ac921b85c Mon Sep 17 00:00:00 2001 From: apidesigner Date: Mon, 20 Feb 2017 10:58:17 +0100 Subject: [PATCH] Updates evolution/naming-conventions.md Auto commit by GitBook Editor --- evolution/naming-conventions.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/evolution/naming-conventions.md b/evolution/naming-conventions.md index 9279e9e..c139df3 100644 --- a/evolution/naming-conventions.md +++ b/evolution/naming-conventions.md @@ -94,6 +94,8 @@ 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. +#### Example + ```yaml swagger: '2.0' info: @@ -104,6 +106,7 @@ info: ### 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. +#### Example ```yaml /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 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 get: summary: Retrieve List of Orders