ascyncapi
Customize the behavior and appearance of AsyncAPI documentation. Requires an AsyncAPI definition.
Options
| Option | Type | Description |
|---|---|---|
| schemaId | String | Schema ID. Defaults to asyncapi. |
| hideInfo | Boolean | Set to true to hide info section including API title. |
| hideOperations | Boolean | Set to true to hide Operations section |
| hideServers | Boolean | Set to true to hide Servers section |
| hideMessages | Boolean | Set to true to hide Messages section |
| hideSchemas | Boolean | Set to true to hide 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
- Learn more about the AsyncAPI docs plugin.