Tag Kinds Registry

Supporting Versions

OpenAPI 3.2 added more structure to tags, including by adding a kind property to a Tag Object. Support for the values in this registry should not be expected until tools add support for the 3.2 version.

Contributing

Please raise a Pull-Request against the main branch and add a new Markdown file to the folder registries/_tag-kind. The name of the file is considered the registration entry, ignoring the file extension. Alternatively you can open an Issue to discuss a registry value.

Values

Value Description
audience Tags with kind: audience indicate the intended audience for an operation.
badge Tags with kind: badge are applied as visible badges in documentation.
nav Tags with kind: nav are used in documentation to group operations into sections