PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs

infoPath is rendered with `//` in the URL

Open
#1,063 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.1k
Forks
315
Avg merge
7d 5h
Merged PRs (30d)
7

Description

https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/78bfd444c557f94a67344d6276025f4958a921bd/packages/docusaurus-plugin-openapi-docs/src/index.ts#L338-L345

We have an issue where the SecuritySchemas name: [name_of_security_schema] is rendered with two // in the URL path which when clicked on leads to the 404 page.

I've taken a look through the code but im pretty confused by it. Any ideas where I might be able to correct my schema or plugin config to avoid this?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading packages/docusaurus-plugin-openapi-docs/src/index.ts around lines 338-345 and packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/SecuritySchemes/index.tsx around line 52. Trace how the SecuritySchemas name becomes a URL, then verify that the generated link uses one slash and no longer leads to a 404.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
documentation, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.