Set the URLs used to download the AsyncAPI description or other documentation related files from the API documentation page.
| Option | Type | Description |
|---|---|---|
| downloadUrls | [downloadUrls object] | Set the URLs used to download the AsyncAPI description or other related to documentation files from the API documentation. |
| Option | Type | Description |
|---|---|---|
| title | string | Custom title displayed in Download AsyncAPI description section for a specific URL. This title can help users quickly identify what the content is about or represents. Users see it before they access the download URL provided in the object. |
| url | string | REQUIRED. An absolute URL to the file. |
The following example sets the download URLs for an AsyncAPI description:
redocly.yaml
asyncapi:
downloadUrls:
- title: Download Events API
url: 'https://example.com/events.yaml'- AsyncAPI configuration - Complete guide to AsyncAPI configuration options for customizing API reference documentation
- AsyncAPI Specification - Official AsyncAPI Specification documentation for understanding event-driven API description standards
- Add AsyncAPI descriptions - Step-by-step guide to adding AsyncAPI documentation to your Redocly project
- Configuration options - Explore other project configuration options for comprehensive documentation customization