# `asyncapi`

Deprecated plugin
This page refers to the legacy Redocly AsyncAPI plugin.

AsyncAPI documentation is now supported natively in Realm and requires no configuration.
For information on how to add AsyncAPI description files to your project, see: [Add AsyncAPI descriptions](/docs/realm/content/api-docs/add-asyncapi-docs).
To migrate to native support for AsyncAPI documentation, see: [Migrate to built-in AsyncAPI docs](/docs/realm/content/api-docs/add-asyncapi-docs-deprecated-plugin#migrate-to-built-in-asyncapi-docs).

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


```yaml
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


```yaml
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

- **[AsyncAPI docs plugin](/docs/realm/content/api-docs/add-asyncapi-docs-deprecated-plugin)** - Learn about the AsyncAPI documentation plugin for integrating event-driven API documentation