Skip to content
Last updated

AsyncAPI extension: x-tagGroups

Redoc uses tags as navigation groupings, so channels with the same tag are shown in the same section of the API reference documentation. The x-tagGroups feature adds an additional layer of navigation above the tags, allowing more granularity. Declare each group with a name, and add the tags to the group.

Group all tags

The x-tagGroups feature forms the top level navigation for the API documentation. Any tag that is not in a group will not be included in the output.

Add all tags to a group in order to include them in the documentation.

Adding a navigation layer using x-tagGroups is particularly useful in making larger or combined APIs' documentation more navigable for users.

Location

The x-tagGroups extension is used at the top level of an AsyncAPI description.

Options

OptionTypeDescription
x-tagGroups[ TagGroup Object ]A list of tag groups.

TagGroup object

OptionTypeDescription
namestringThe display name for the tag, used in the navigation bar and as a section heading.
tags[ string ]List of tags to include in this group.

Examples

The following example shows how to organize tags into logical groups. The x-tagGroups extension is used to separate core ride operations from supporting services.

asyncapi: 3.0.0
components:
  tags:
    Rides:
      name: Rides
      description: Core ride lifecycle events and status updates
    Payments:
      name: Payments
      description: Financial transaction events and payment processing
    Notifications:
      name: Notifications
      description: Real-time notifications for drivers and passengers

x-tagGroups:
 - name: Core Services
   tags:
    - Rides
    - Payments
 - name: Communication
   tags:
    - Notifications

The navigation in the API reference documentation using this x-tagGroups configuration will have the following structure:

  • Core Services
    • Rides
    • Payments
  • Communication
    • Notifications

Resources

 
Next page