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:

x-enum-varnames

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

Enum var names can be defined as such in OpenAPI:

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.

x-labels

x-labels adds one or more labels to a schema property's description.

Labels can be defined as such in OpenAPI:

When x-labels is set, each label is placed in the description, unstyled, using the text provided. Each label is given the CSS classes label and the value of type. This can be used to add specific labels with specific colours, like badges on a description.