PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs
Doucmentation method not able to access
Open
Nobody has claimed this yet.
bug
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 315
- Avg merge
- 7d 5h
- Merged PRs (30d)
- 7
Description
Describe the bug
- I check out the demo exmple install the package and when I visit to the any methods of the api documentation the page is getting broken.
Expected behavior
- page should show the respective GET POST method
Current behavior
- Page is getting broken
Steps to reproduce
- Check out the demo example and install the package.
- visit /petstore/add-pet route page will brek.
Screenshots
- Version used:
"@docusaurus/core": "3.5.2",
"@docusaurus/plugin-google-gtag": "3.5.2",
"@docusaurus/preset-classic": "3.5.2",
"clsx": "^1.1.1",
"docusaurus-plugin-openapi-docs": "^4.0.1",
"docusaurus-theme-openapi-docs": "^4.0.1",
"prism-react-renderer": "^2.3.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the demo example and reproduce the breakage at the /petstore/add-pet route using the listed package versions. Inspect the generated API documentation page and its browser error, then compare the expected GET and POST method display with the current result. Done means the route loads and shows the respective methods without breaking.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, react, typescript
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100