nitrojs / nitrojs/nitro

Exclude tags for openAPI option

Open
#3,643 0 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement v2 v3
Dominant language
TypeScript
Stars
11.2k
Forks
899
Avg merge
2d 24m
Merged PRs (30d)
40

Description

Describe the feature

The openAPI implementation automatically adds some Internal routes to the openapi.json file and therefore swagger UI.

In framework usage (nuxt) this generates this kind of specification

Image

It would be nice a way to exclude the automatically generated Internal tags from the openAPI specification.

Additional information
  • Would you be willing to help implement this feature?

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 tracing the OpenAPI implementation that adds internal routes and tags to openapi.json, considering the Nuxt framework usage described in the issue. Define an option that excludes the automatically generated Internal tags, then verify that the generated specification and Swagger UI no longer include them.

Written by the indexing model from the issue text.

Assessment

Tech stack
nuxt, openapi, typescript
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.