PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs
Add configuration option to hide "UNTAGGED" category
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 315
- Avg merge
- 7d 5h
- Merged PRs (30d)
- 7
Description
Is your feature request related to a problem?
When generating API documentation using tags, the plugin always displays an "UNTAGGED" category for operations without tags. In some cases, I want to hide this category completely as it creates unnecessary clutter in the documentation.
Describe the solution you'd like
Please add a new configuration parameter showUntagged: boolean (defaulting to true) that allows users to control the visibility of the "UNTAGGED" category. When set to false, operations without tags would be hidden from the documentation.
Describe alternatives you've considered
I've considered filtering the OpenAPI spec before passing it to the plugin, but this requires additional preprocessing steps and doesn't integrate cleanly with the existing workflow.
Additional context
I'm working on documentation for a large API where most endpoints are properly tagged, but a few legacy endpoints remain untagged. I want to present a clean, organized documentation experience that focuses on the properly categorized endpoints while we work on tagging the remaining ones.
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
No file or test path is identified in the issue. Start by locating the plugin configuration handling and the rendering of the "UNTAGGED" category, then trace how operations without tags are included. Done means a showUntagged option defaults to true and, when false, excludes untagged operations from generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100