Last updated

downloadUrls

Set the URLs used to download the OpenAPI description or other documentation related files from the API documentation page.

Options

OptionTypeDescription
downloadUrls[downloadUrls object]Set the URLs used to download the OpenAPI description or other related to documentation files from the API documentation.

API description URL object

OptionTypeDescription
titlestringCustom 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.
urlstringREQUIRED. An absolute URL to the file.

Examples

The following example sets the download URLs for an OpenAPI description:

redocly.yaml
openapi:
  downloadUrls:
    - title: Download OpenApiDescription
      url: 'https://example.com/museum.yaml'
  • hideDownloadButtons - Toggle the appearance of the buttons used to download your API description.
  • openapi - Learn more about using openapi configuration.

Resources