Skip to content
Last updated

asyncapi

Products:RedocRedocRealmRealm
Plans:ProEnterpriseEnterprise+

Customize the behavior and appearance of AsyncAPI documentation. Requires an AsyncAPI description file.

Options

OptionTypeDescription
schemaIdstringSchema ID. Defaults to asyncapi.
hideInfobooleanSet to true to hide the info section including API title.
hideOperationsbooleanSet to true to hide the Operations section.
hideServersbooleanSet to true to hide the Servers section.
hideMessagesbooleanSet to true to hide the Messages section.
hideSchemasbooleanSet to true to hide the Schemas section.

Examples

Change default schema id and hide servers section

plugins:
  # Enable plugin in project
  - '@redocly/portal-plugin-async-api/plugin.js'
asyncapi:
  schemaId: StreetlightAPI
  hideServers: true

Change default schema id and show all the sections except schemas section

plugins:
  # Enable plugin in project
  - '@redocly/portal-plugin-async-api/plugin.js'
asyncapi:
  schemaId: StreetlightAPI
  hideErrors: false
  hideInfo: false
  hideOperations: false
  hideServers: false
  hideMessages: false
  hideSchemas: true

Resources

banner