Correct link for Export button

[dmitriyrotaenko]

Hi! Thank you for this beautiful product.

I am having a hard time configuring the downloadUrl property for the Export button but it won't work.

Here's my plugin config:

    [
      'docusaurus-plugin-openapi-docs',
      {
        id: 'openapi',
        docsPluginId: 'classic',
        config: {
          "balances-api": {
            specPath: 'docs/dir-1/dir-2/openapi-specs/balances-api.yaml,
            outputDir: 'docs/dir-1/dir-2/endpoints/balances-api',
            sidebarOptions: {
              groupPathsBy: "tag",
              categoryLinkSource: "tag",
            },
            downloadUrl: '/dir-1/dir-2/openapi-specs/balances-api.yaml'
          },
        }
      }
    ],

When I click Export, the download fails. I also noticed a behavior that could be somehow connected to my issue. If I include the openspec file as a markdown link to a page, the link looks like this:

http://localhost:3000/assets/files/balances-api-853c36dc9660d12cda27dc4d2efbe321.yaml

There's some hash in the title. Is it possible that this hash somehow breaks the Export button?

Adding an absolute URL of the file from the deployed website won't work, because the hash is changed everytime I change content of the openspec file.

What's the problem with my config and how should I fix it? Any help is insanely appreciated!

[sserrata]

Hi @dmitriyrotaenko, hard to provide guidance without know the error you're seeing but, FWIW, the Export button requires a URL or link to the OpenAPI spec, not a local file path.

[dmitriyrotaenko]

Thank you, for a quick answer!

Can you please elaborate on what you mean by 'link to the OpenAPI spec, not a local file path?'

In docusaurus.config.ts file of the Open API project there's a line:

docusaurus-openapi-docs/demo/docusaurus.config.ts

Line 301 in 61e4de7

downloadUrl: "/petstore.yaml",

Looks like path to some local file or am I missing something?

[sserrata]

That's a URL path. To make it work I placed a copy of the spec under the static directory so that it is served at the / path.

[dmitriyrotaenko]

I see, thank you