Download button format and file name (yaml instead of json)

[rohit-gohri]

Download button format and file name (yaml instead of json)

[rohit-gohri]

Just added a fix in #78 to allow passing both spec and specUrl, that way you can have the download button pointed to a yaml in static folder while still having parsed yaml for faster loading of page.

Will be out in next release

[rohit-gohri]

Currently the yaml is read during the build process, converted to JSON and passed to Redoc. If you want to pass the raw yaml, better to put it in the static folder and pass a URL to it in the plugin options.

[AndreasA]

@rohit-gohri Thanks for the feedback. I already put the file into the static folder.

How would be the best / recommended way to pass the URL to the plugin? Is there an example. I see that redoc itself seems to have options downloadLink and downloadFileName but I am not 100% sure how to use those.

[AndreasA]

@rohit-gohri OK, if I provide a specUrl it works as intended. However, how can I set the spec URL correctly in the docusaurus.config.js file as the hostname etc. is not yet defined and just using /path/to/spec.yaml does not work as it fails with an invalid URI error.

[rohit-gohri]

The recommended way by me would be to use the converted JSON as that is the fastest to load as no parsing needs to happen on client side.

If you want to allow downloading YAML and are okay with a little loading time, then put the the yaml in the static folder and pass the relative path in the specUrl option. Like here:

redocusaurus/example/docusaurus.config.js

Lines 18 to 21 in 55649a0

	{
	specUrl: `${process.env.DEPLOY_BASE_URL || '/'}openapi-page.yaml`,
	routePath: '/using-relative-url/'
	},

[rohit-gohri]

(after you update to the latest version, just released a patch which allows for relative paths in urls)

[AndreasA]

@rohit-gohri Thanks for adding support of this so fast.

So if I have a fix base URL, something like this ${BASE_URL}/path/to/static/openapi.yaml would be fine.

At least it works locally. Haven't deployed it ye but should work there too.

[rohit-gohri]

So if I have a fix base URL, something like this ${BASE_URL}/path/to/static/openapi.yaml would be fine.

Yup, ideally I should be using the useBaseUrl hook in the Redoc component to automatically add it. But for now this works, maybe a fix for later.

[rogatec]

Just to be curious - the default name of the download file is swagger.json any chance to change the filename?