Set the URLs used to download the OpenAPI description or other documentation related files from the API documentation page.
| Option | Type | Description |
|---|---|---|
| downloadUrls | [downloadUrls object] | Set the URLs used to download the OpenAPI description or other related to documentation files from the API documentation. |
| Option | Type | Description |
|---|---|---|
| title | string | Custom title to use for displaying in Download OpenAPI specification section for specific url. This title can help users quickly identify what the content is about or what it represents 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 OpenAPI description:
redocly.yaml
openapi:
downloadUrls:
- title: Download OpenApiDescription
url: 'https://example.com/museum.yaml'- OpenAPI configuration - Complete guide to OpenAPI configuration options for customizing API reference documentation
- Hide download buttons - Toggle the appearance of download buttons used to access your API description files
- OpenAPI Specification - Official OpenAPI Specification documentation for understanding API description standards
- OpenAPI visual reference
- Explore other configuration options for your project.