docusaurus-openapi-docs icon indicating copy to clipboard operation
docusaurus-openapi-docs copied to clipboard

Enhanced Export Functionality for Local OpenAPI Files

Open hjhrwerv2423 opened this issue 1 year ago • 0 comments

I want the ability to specify a local YAML file in the downloadUrl, located at /static/openapi.yaml on my system. Currently, I lack this capability, so I'm using a workaround. I simply mention the path in the description section of openapi.yaml, and everything works. However, I would prefer to use the standard mechanism with an attractive 'export' button.

Download openapi.yaml

Is your feature request related to a problem?

No.

Describe the solution you'd like

I seek a straightforward and standardized way to link to a local YAML file directly through the downloadUrl parameter. This method should enable users to download the file by clicking an 'export' button, enhancing user experience and maintaining a neat interface.

Describe alternatives you've considered

As a temporary solution, I manually include the file path in the API documentation's description section, allowing users to access and download the file. However, this approach lacks the polish and ease of use that a dedicated export button would offer.

Additional context

This feature request arises from the need for a more integrated and user-friendly method to share local YAML files with API consumers.

hjhrwerv2423 avatar Feb 13 '24 13:02 hjhrwerv2423