From d340e70aa465ca8ca0beb652496bc8d765d74ab5 Mon Sep 17 00:00:00 2001 From: Sergio Regueira Date: Thu, 31 Jan 2019 15:20:36 +0100 Subject: [PATCH] Group documentation of x-traitTag extension --- docs/redoc-vendor-extensions.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/redoc-vendor-extensions.md b/docs/redoc-vendor-extensions.md index ec30be89..c6674a74 100644 --- a/docs/redoc-vendor-extensions.md +++ b/docs/redoc-vendor-extensions.md @@ -134,13 +134,6 @@ Extends OpenAPI [Tag Object](http://swagger.io/specification/#tagObject) | :------------- | :------: | :---------- | | x-traitTag | boolean | In Swagger two operations can have multiple tags. This property distinguishes between tags that are used to group operations (default) from tags that are used to mark operation with certain trait (`true` value) | -#### x-displayName - -| Field Name | Type | Description | -| :------------- | :------: | :---------- | -| x-displayName | string | Defines the text that is used for this tag in the menu and in section headings | - - ###### Usage in Redoc Tags that have `x-traitTag` set to `true` are listed in side-menu but don't have any subitems (operations). Tag `description` is rendered as well. This is useful for handling out common things like Pagination, Rate-Limits, etc. @@ -161,6 +154,12 @@ description: Pagination description (can use markdown syntax) x-traitTag: true ``` +#### x-displayName + +| Field Name | Type | Description | +| :------------- | :------: | :---------- | +| x-displayName | string | Defines the text that is used for this tag in the menu and in section headings | + ### Operation Object vendor extensions Extends OpenAPI [Operation Object](http://swagger.io/specification/#operationObject) #### x-code-samples