From a95e8660417400af1fb7d95cbf1cd368a766af54 Mon Sep 17 00:00:00 2001 From: Roman Hotsiy Date: Mon, 1 Feb 2016 19:38:21 +0200 Subject: [PATCH] Fix md tables in vendor extensions doc --- docs/redoc-vendor-extensions.md | 35 +++++++++++++++++---------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/docs/redoc-vendor-extensions.md b/docs/redoc-vendor-extensions.md index e6dcac25..5ae5b6ec 100644 --- a/docs/redoc-vendor-extensions.md +++ b/docs/redoc-vendor-extensions.md @@ -4,9 +4,10 @@ ReDoc makes use of the following [vendor extensions](http://swagger.io/specifica ### [Info Object](http://swagger.io/specification/#infoObject) vendor extensions #### x-logo -| Field Name | Type | Description -| :------------- | :------: | -| x-logo | [Logo Object](#logoObject) | The information about API logo + +| Field Name | Type | Description | +| :------------- | :-----------: | :---------- | +| x-logo | [Logo Object](#logoObject) | The information about API logo | ##### Usage in Redoc `x-logo` is used to specify API logo. The corresponding image are displayed just above side-menu. @@ -14,10 +15,10 @@ ReDoc makes use of the following [vendor extensions](http://swagger.io/specifica #### Logo Object The information about API logo ##### Fixed fields -| Field Name | Type | Description -| :---------- | :------: | -| url | string | The URL pointing to the spec logo. MUST be in the format of a URL -| backgroundColor | string | background color to be used. MUST be in [CSS color syntax](https://developer.mozilla.org/en/docs/Web/CSS/color) +| Field Name | Type | Description | +| :-------------- | :------: | :---------- | +| url | string | The URL pointing to the spec logo. MUST be in the format of a URL +| backgroundColor | string | background color to be used. MUST be in [CSS color syntax](https://developer.mozilla.org/en/docs/Web/CSS/color) | ##### x-logo example @@ -49,9 +50,9 @@ The information about API logo ### [Tag object](http://swagger.io/specification/#tagObject) vendor extensions #### x-traitTag -| Field Name | Type | Description -| :------------- | :------: | -| x-traitTag | boolean | In Swagger two operations can have multiply tags. This property distinguish between tags that are used to group operations (default) from tags that are used to mark operation with certain trait (`true` value) +| Field Name | Type | Description | +| :------------- | :------: | :---------- | +| x-traitTag | boolean | In Swagger two operations can have multiply tags. This property distinguish between tags that are used to group operations (default) from tags that are used to mark operation with certain trait (`true` value) | ##### 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. @@ -74,9 +75,9 @@ x-traitTag: true ### [Operation Object](http://swagger.io/specification/#operationObject) vendor extensions #### x-code-samples -| Field Name | Type | Description -| :------------- | :------: | -| x-code-samples | [[Code Sample Object](#codeSampleObject)] | A list of code samples associated with operation +| Field Name | Type | Description | +| :------------- | :------: | :---------- | +| x-code-samples | [[Code Sample Object](#codeSampleObject)] | A list of code samples associated with operation | ##### Usage in ReDoc x-code-samples are rendered on the right panel of ReDoc @@ -84,10 +85,10 @@ x-code-samples are rendered on the right panel of ReDoc #### Code Sample Object Operation code sample ##### Fixed fields -| Field Name | Type | Description -| :---------- | :------: | :----------- -| lang | string | Code sample language. Value should be one of the following [list](https://github.com/github/linguist/blob/master/lib/linguist/popular.yml) -| source | string | Code sample source code +| Field Name | Type | Description | +| :---------- | :------: | :----------- | +| lang | string | Code sample language. Value should be one of the following [list](https://github.com/github/linguist/blob/master/lib/linguist/popular.yml) | +| source | string | Code sample source code | ##### Code Sample Object example