OpenAPI Extensions

The following extensions are available on DeveloperHub:

x-tagGroups

x-tagGroups serves to group operations within the index, effectively establishing an additional hierarchy. This feature is activated exclusively when the index is configured to be collapsible.

In OpenAPI, tag groups can be defined in the following manner:

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 utilizing variables throughout the API references, you can also leverage these variables in the following ways:

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

These variables are particularly valuable for creating links within markdown descriptions.