OpenAPI Extensions

The following extensions are available on DeveloperHub.

x-tagGroups

x-tagGroups groups operations in the index, creating one further hierarchy. This feature is only enabled if the index is set to be collapsible.

Tag groups can be defined as such in OpenAPI:

openapi: '3.0'

info: ...

tags:

  - name: Lion

  - name: Cheetah

  - name: Dolphin

  - name: Octopus

x-tagGroups:

  - name: Feline

    tags:

      - Lion

      - Cheetah

  - name: Sea

    tags:

      - Dolphin

      - Octopus

x-enum-varnames

x-enum-varnames gives a secondary name for an enum.

Enum var names can be defined as such in OpenAPI:

Animal:

  type: integer

  enum:

    - 33

    - 21

  x-enum-varnames:

    - Dog

    - Cat

Variables

In addition to using variables throughout the API references, those variables can also be used:

• %_.project.base_path% for project base path.
• %_.version.slug% for version slug.
• %_.section.slug% for API reference slug.

Those variables are specifically useful to construct links inside markdown descriptions.