show the display name in the sidebar

[elmarburke]

First of all: thanks for providing this package!

We missed a little feature - namely that the display names of tags are shown in the sidebar.
The PR adds exactly this possibility. I extended the code to loop over the tags, read the original file and replace the pure tag with the x-displayName if it's available.

For me, reading the file again, didn't looked the most elegant solution, but I didn't found another way to get the data otherwise. If you have an idea, I'm happy to change it :)

[netlify]

✔️ Deploy Preview for docusaurus-openapi ready!

🔨 Explore the source changes: 66925df

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-openapi/deploys/61e5477beb2501000805cdeb

😎 Browse the preview: https://deploy-preview-154--docusaurus-openapi.netlify.app

[bourdakos1]

Thank you for the contribution 😁 Looks great, I will try to take a closer look at the code this weekend!

[bourdakos1]

@elmarburke I think a lot of this could be simplified if we modify createItems directly in order to override tags with the finalized list of display names. That way we wouldn't have to touch the groupByTags function and we wouldn't need to re-read the spec files.

something like:

const apiPage = {
  type: "api",
  // ... other metadata
  api: {
    ...defaults,
    tags: operationObject.tags.map(t => getTagDisplayName(t, openapiData)),
    // ... other overrides
  },
}

So that { tags: ["store"] } would end up as { tags: ["Petstore orders"] }

[elmarburke]

That does sound like a better idea in deed. Somehow I missed this very function 😮

[bourdakos1]

LGTM