Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-09-21 11:18:48 +03:00
Code Issues Packages Projects Releases Wiki Activity

doc styling fixes

Browse Source
This commit is contained in:
Roman Hotsiy 2016-02-01 19:49:57 +02:00
parent a95e866041
commit 9dd93e8895
1 changed files with 29 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,7 +1,7 @@
# ReDoc vendor extensions
ReDoc makes use of the following [vendor extensions](http://swagger.io/specification/#vendorExtensions)
### <a name="infoObject"></a> [Info Object](http://swagger.io/specification/#infoObject) vendor extensions
### <a name="infoObject"></a>[Info Object](http://swagger.io/specification/#infoObject) vendor extensions
#### <a name="x-logo"></a> x-logo
@ -9,20 +9,21 @@ ReDoc makes use of the following [vendor extensions](http://swagger.io/specifica
| :------------- | :-----------: | :---------- |
| x-logo | [Logo Object](#logoObject) | The information about API logo |
##### Usage in Redoc
###### Usage in Redoc
`x-logo` is used to specify API logo. The corresponding image are displayed just above side-menu.
#### <a name="logoObject"></a> Logo Object
#### <a name="logoObject"></a>Logo Object
The information about API logo
##### Fixed fields
###### 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) |
##### x-logo example
```yaml
###### x-logo example
json
```json
{
"info": {
"version": "1.0.0",
@ -34,15 +35,14 @@ The information about API logo
}
}
```
yaml
```yaml
{
info:
version: "1.0.0"
title: "Swagger Petstore"
x-logo:
url: "https://rebilly.github.io/ReDoc/petstore-logo.png"
backgroundColor: "white"
}
info:
version: "1.0.0"
title: "Swagger Petstore"
x-logo:
url: "https://rebilly.github.io/ReDoc/petstore-logo.png"
backgroundColor: "white"
```
@ -54,11 +54,12 @@ The information about API logo
| :------------- | :------: | :---------- |
| 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
###### 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.
##### x-traitTag example
###### x-traitTag example
json
```json
{
"name": "Pagination",
@ -66,6 +67,7 @@ This is useful for handling out common things like Pagination, Rate-Limits, etc.
"x-traitTag": true
}
```
yaml
```yaml
name: Pagination
description: Pagination description (can use markdown syntax)
@ -77,30 +79,30 @@ x-traitTag: true
#### <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 |
| 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
###### Usage in ReDoc
`x-code-samples` are rendered on the right panel of ReDoc
#### <a name="codeSampleObject"></a> Code Sample Object
#### <a name="codeSampleObject"></a>Code Sample Object
Operation code sample
##### Fixed fields
###### 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 |
##### Code Sample Object example
```yaml
###### Code Sample Object example
json
```json
{
"lang": "JavaScript",
"source": "console.log('Hello World');"
}
```
yaml
```yaml
{
lang: JavaScript
source: console.log('Hello World');
}
lang: JavaScript
source: console.log('Hello World');
```