# `asyncapi`

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

## Options

| Option | Type | Description |
|  --- | --- | --- |
| schemaId | string | Schema ID.
Defaults to `asyncapi`. |
| hideInfo | boolean | Set to `true` to hide the `info` section including API title. |
| hideOperations | boolean | Set to `true` to hide the **Operations** section. |
| hideServers | boolean | Set to `true` to hide the **Servers** section. |
| hideMessages | boolean | Set to `true` to hide the **Messages** section. |
| hideSchemas | boolean | Set to `true` to hide the **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

- **[Supported AsyncAPI extensions](/docs/realm/content/api-docs/asyncapi-extensions)** - Complete list of all AsyncAPI extensions supported by Redocly for enhanced API documentation