Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-11-22 08:36:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fix md tables in vendor extensions doc

Browse Source
This commit is contained in:
Roman Hotsiy 2016-02-01 19:38:21 +02:00
parent 8542d88523
commit a95e866041
1 changed files with 18 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/redoc-vendor-extensions.md
View File

@ -4,9 +4,10 @@ ReDoc makes use of the following [vendor extensions](http://swagger.io/specifica
### <a name="infoObject"></a> [Info Object](http://swagger.io/specification/#infoObject) vendor extensions
#### <a name="x-logo"></a> 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
#### <a name="logoObject"></a> 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
#### <a name="x-traitTag"></a> 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
#### <a name="x-code-samples"></a> 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
#### <a name="codeSampleObject"></a> 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