PaloAltoNetworks/docusaurus-openapi-docs

View on GitHub

🦝 OpenAPI plugin for generating API reference docs in Docusaurus v3.

Stars: 1.1k
Forks: 315
Open beginner issues: 0
Indexed issues: 79
Avg merge: 7d 5h
Merged PRs (30d): 7

Dominant language: TypeScript
License: MIT
Last GitHub push: Sep 8, 2026
Latest indexed: Sep 20, 2026
Contributing guide: Contributing guide
Code of conduct: Code of conduct
Beginner labels: help wanted

Beginner friendly Everything

Open All

79 open issues indexed

Same spec renders differently between this repos demo directory and a fresh install Open

bug

Difficulty 4/5 3-5 days Newbie friendliness 48/100

PaloAltoNetworks/docusaurus-openapi-docs#1473 · 1 comment · 1 reaction · Opened May 18, 2026
Option to display all endpoints on a single page Open

enhancement

Difficulty 4/5 3-5 days Newbie friendliness 55/100

PaloAltoNetworks/docusaurus-openapi-docs#1472 · 1 comment · 2 reactions · Opened May 15, 2026
Only show one "Introduction" item with `groupPathsBy: "tagGroup"` and `categoryLinkSource: "tag"` Open

enhancement

Difficulty 4/5 3-5 days Newbie friendliness 48/100

PaloAltoNetworks/docusaurus-openapi-docs#1297 · 2 comments · 1 reaction · Opened Feb 2, 2026
Incompatibility with LunaticMuch/docusaurus-terminology plugin Open

bug reviewing :eyes:

Difficulty 4/5 3-5 days Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#1135 · 1 comment · Opened Apr 28, 2025
Introduce incremental `gen-api-docs` command to support watch functionality Open

enhancement

Difficulty 5/5 Over a week Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#1128 · 4 reactions · Opened Apr 17, 2025
Add configuration option to hide "UNTAGGED" category Open

enhancement

Difficulty 3/5 1-2 days Newbie friendliness 55/100

PaloAltoNetworks/docusaurus-openapi-docs#1127 · 3 reactions · Opened Apr 14, 2025
URL Function Undefined Open

bug reviewing :eyes:

Difficulty 4/5 3-5 days Newbie friendliness 45/100

PaloAltoNetworks/docusaurus-openapi-docs#1116 · 2 comments · Opened Mar 24, 2025
Distinct Pages By Discriminator Open

enhancement

Difficulty 5/5 Over a week Newbie friendliness 25/100

PaloAltoNetworks/docusaurus-openapi-docs#1113 · 3 comments · Opened Mar 19, 2025
How do to customise logic in the generated mdx? Open

Difficulty 5/5 Over a week Newbie friendliness 25/100

PaloAltoNetworks/docusaurus-openapi-docs#1112 · 1 comment · Opened Mar 19, 2025
Duplicate routes and wrong page if tagname and operationid have the same name Open

bug

Difficulty 4/5 3-5 days Newbie friendliness 45/100

PaloAltoNetworks/docusaurus-openapi-docs#1110 · 6 comments · 1 reaction · Opened Mar 13, 2025
The long API call gets lost Open

bug

Difficulty 4/5 3-5 days Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#1104 · 1 comment · 1 reaction · Opened Mar 7, 2025
Add support for typescript language Open

enhancement

Difficulty 2/5 1-3 hours Newbie friendliness 48/100

PaloAltoNetworks/docusaurus-openapi-docs#1102 · Opened Mar 5, 2025
duplicate spec outputs causing conflicts Open

documentation

Difficulty 4/5 3-5 days Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#1101 · Opened Mar 5, 2025
Wrong ProvidePlugin of URL Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#1096 · 6 comments · 5 reactions · Opened Feb 25, 2025
Is is possible to customize admonition section for deprecated api? Open

enhancement

Difficulty 4/5 3-5 days Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#1082 · 2 comments · Opened Feb 11, 2025
Flag --all-versions not working Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 52/100

PaloAltoNetworks/docusaurus-openapi-docs#1080 · 2 comments · Opened Feb 5, 2025
Clicking 'Introduction' in sidebar (grouped by tagGroup) expands all groups instead of one Open

bug

Difficulty 4/5 3-5 days Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#1076 · 3 comments · Opened Jan 30, 2025
infoPath is rendered with `//` in the URL Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#1063 · 2 comments · Opened Jan 13, 2025
Does not build on Cloudflare pages. Open

bug

Difficulty 4/5 3-5 days Newbie friendliness 25/100

PaloAltoNetworks/docusaurus-openapi-docs#1048 · 4 comments · 1 reaction · Opened Dec 14, 2024
Issue in request section with postman request always being set to content type x-www-form-urlencoded Open

bug

Difficulty 4/5 3-5 days Newbie friendliness 42/100

PaloAltoNetworks/docusaurus-openapi-docs#1027 · 1 comment · Opened Nov 23, 2024
DiscriminatorNode access on undefined property Open

bug reviewing :eyes:

Difficulty 4/5 3-5 days Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#1026 · 3 comments · 2 reactions · Opened Nov 21, 2024
Strange type issue Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#1015 · 10 comments · 6 reactions · Opened Nov 4, 2024
Docusarus 3.6.0 upgrade breaks this package Open

bug

Difficulty 4/5 3-5 days Newbie friendliness 25/100

PaloAltoNetworks/docusaurus-openapi-docs#1013 · 22 comments · 2 reactions · Opened Nov 4, 2024
Strip markdown from parameter placeholder Open

bug reviewing :eyes:

PaloAltoNetworks/docusaurus-openapi-docs#1002 · 16 comments · 1 assignee · Opened Oct 22, 2024
Is it possible to escape HTML so I can use MDX in descriptions? Open

reviewing :eyes:

PaloAltoNetworks/docusaurus-openapi-docs#993 · 10 comments · 1 reaction · 1 assignee · Opened Oct 10, 2024
Add flag to re-write sidebar.js (and other auto-generated files) Open

enhancement

Difficulty 3/5 1-2 days Newbie friendliness 45/100

PaloAltoNetworks/docusaurus-openapi-docs#983 · 1 comment · 1 reaction · Opened Oct 3, 2024
defualt values dont show on enums when using a ref Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#977 · 2 comments · Opened Sep 25, 2024
Support for anyOf/minProperties for required schema properties. Open

bug

Difficulty 4/5 3-5 days Newbie friendliness 42/100

PaloAltoNetworks/docusaurus-openapi-docs#976 · 3 comments · 1 reaction · Opened Sep 23, 2024
They are probably incompatible. Values: "integer" "string" Open

bug

Difficulty 4/5 3-5 days Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#973 · 1 comment · Opened Sep 18, 2024
Questions - hide http clients column, show Request examples as tabs, hide `Example (from schema)` Open

Difficulty 4/5 3-5 days Newbie friendliness 20/100

PaloAltoNetworks/docusaurus-openapi-docs#970 · 2 comments · Opened Sep 17, 2024
None doesn't exist on `categoryLinkSource` Open

documentation

Difficulty 1/5 Under an hour Newbie friendliness 52/100

PaloAltoNetworks/docusaurus-openapi-docs#967 · 1 reaction · Opened Sep 15, 2024
Duplicate description on empty additionalProperties Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 45/100

PaloAltoNetworks/docusaurus-openapi-docs#966 · Opened Sep 13, 2024
Not able to run docusaurus with Material UI components Open

documentation

Difficulty 4/5 3-5 days Newbie friendliness 28/100

PaloAltoNetworks/docusaurus-openapi-docs#965 · 3 comments · Opened Sep 13, 2024
Doucmentation method not able to access Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 30/100

PaloAltoNetworks/docusaurus-openapi-docs#953 · Opened Sep 7, 2024
Unable to render example from schema when using anyOf or other multiple responses Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#946 · 6 comments · Opened Sep 5, 2024
Array with enum values in items: nested description not displayed Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#942 · 3 comments · Opened Sep 3, 2024
Support showing openapi Links Open

enhancement

Difficulty 4/5 3-5 days Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#938 · 1 reaction · Opened Aug 28, 2024
categoryLinkSource does not accept none Open

documentation

Difficulty 2/5 1-3 hours Newbie friendliness 45/100

PaloAltoNetworks/docusaurus-openapi-docs#933 · 1 reaction · Opened Aug 26, 2024
Question/documentation for swizzling components with regards to TypeScript definitions Open

documentation

Difficulty 4/5 3-5 days Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#920 · 2 comments · Opened Aug 20, 2024
Question: How to render Sidebar Menu on a custom page Open

Difficulty 3/5 1-2 days Newbie friendliness 25/100

PaloAltoNetworks/docusaurus-openapi-docs#914 · 1 comment · Opened Aug 14, 2024
When configured for versioning, I can't use an outputDir outside the docs plugin's path Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 38/100

PaloAltoNetworks/docusaurus-openapi-docs#913 · 1 comment · Opened Aug 14, 2024
The sample code is wrong when using in query parameters with a list of values Open

bug roadmap

Difficulty 3/5 1-2 days Newbie friendliness 38/100

PaloAltoNetworks/docusaurus-openapi-docs#909 · 1 comment · Opened Aug 6, 2024
Strip markdown syntax from frontmatter Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 45/100

PaloAltoNetworks/docusaurus-openapi-docs#908 · Opened Aug 6, 2024
Incorrect rendering when referencing data from schema Open

bug

Difficulty 4/5 3-5 days Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#907 · 2 comments · Opened Aug 6, 2024
What are the variables in api.mustache template? Open

documentation

Difficulty 4/5 3-5 days Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#900 · 4 comments · Opened Jul 29, 2024
Ignore unknown vendor extensions Open

enhancement question

Difficulty 3/5 1-2 days Newbie friendliness 38/100

PaloAltoNetworks/docusaurus-openapi-docs#891 · 7 comments · Opened Jul 17, 2024
Custom item naming and path generation Open

enhancement

Difficulty 4/5 3-5 days Newbie friendliness 38/100

PaloAltoNetworks/docusaurus-openapi-docs#886 · 2 comments · 1 reaction · Opened Jul 12, 2024
Example & externalDocs attributes not displaying Open

enhancement roadmap

Difficulty 3/5 1-2 days Newbie friendliness 35/100

PaloAltoNetworks/docusaurus-openapi-docs#885 · 1 reaction · Opened Jul 11, 2024
Huge swagger.json file is not being processed Open

Difficulty 4/5 3-5 days Newbie friendliness 25/100

PaloAltoNetworks/docusaurus-openapi-docs#884 · 4 comments · Opened Jul 10, 2024
Fenced code blocks started with `~~~` are incorrectly cleaned in v3 Open

bug roadmap

Difficulty 2/5 1-3 hours Newbie friendliness 58/100

PaloAltoNetworks/docusaurus-openapi-docs#883 · 2 comments · Opened Jul 8, 2024

PaloAltoNetworks/docusaurus-openapi-docs

Get new issues in your inbox