redoc/docs/redoc-vendor-extensions.md

ReDoc vendor extensions

ReDoc makes use of the following vendor extensions

Swagger Object vendor extensions

Extend OpenAPI root Swagger Object

x-servers

Backported from OpenAPI 3.0 servers. Currently doesn't support templates.

x-tagGroups

Field Name	Type	Description
x-tagGroups	[ Tag Group Object ]	A list of tag groups

Usage in Redoc

x-tagGroups is used to group tags in the side menu

Tag Group Object

Information about tags group

Fixed fields

Field Name	Type	Description
name	string	The group name
tags	[ string ]	List of tags to include in this group

x-tagGroups example

json

{
  "x-tagGroups": [
    {
      "name": "User Management",
      "tags": ["Users", "API keys", "Admin"]
    },
    {
      "name": "Statistics",
      "tags": ["Main Stats", "Secondary Stats"]
    }
  ]
}

yaml

x-tagGroups:
  - name: User Management
    tags:
      - Users
      - API keys
      - Admin
  - name: Statistics
    tags:
      - Main Stats
      - Secondary Stats

Logo Object

Info Object vendor extensions

Extends OpenAPI Info Object

x-logo

Field Name	Type	Description
x-logo	Logo Object	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.

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 RGB color in [hexadecimal format] (https://en.wikipedia.org/wiki/Web_colors#Hex_triplet)

x-logo example

json

{
  "info": {
    "version": "1.0.0",
    "title": "Swagger Petstore",
    "x-logo": {
      "url": "https://rebilly.github.io/ReDoc/petstore-logo.png",
      "backgroundColor": "#FFFFFF"
    }
  }
}

yaml

info:
  version: "1.0.0"
  title: "Swagger Petstore"
  x-logo:
    url: "https://rebilly.github.io/ReDoc/petstore-logo.png"
    backgroundColor: "#FFFFFF"

Tag Object vendor extensions

Extends OpenAPI Tag Object

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)

x-displayName

Field Name	Type	Description
x-displayName	string	Define 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.

x-traitTag example

json

{
    "name": "Pagination",
    "description": "Pagination description (can use markdown syntax)",
    "x-traitTag": true
}

yaml

name: Pagination
description: Pagination description (can use markdown syntax)
x-traitTag: true

Operation Object vendor extensions

Extends OpenAPI Operation Object

x-code-samples

Field Name	Type	Description
x-code-samples	[ Code Sample Object ]	A list of code samples associated with operation

Usage in ReDoc

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
source	string	Code sample source code

Code Sample Object example

json

{
  "lang": "JavaScript",
  "source": "console.log('Hello World');"
}

yaml

lang: JavaScript
source: console.log('Hello World');

Schema Object vendor extensions

Extends OpenAPI Schema Object

x-nullable

Field Name	Type	Description
x-nullable	boolean	marks schema as a nullable

Usage in ReDoc

Schemas marked as x-nullable are marked in ReDoc with the label Nullable