Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add openAPIEnabled property to route metas and route rules #2890

Open
wants to merge 2 commits into
base: v2
Choose a base branch
from

Conversation

horvbalint
Copy link
Contributor

@horvbalint horvbalint commented Nov 18, 2024

πŸ”— Linked issue

#2889

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

This PR adds a new property openAPIEnabled to the NitroRouteMeta and NitroRouteConfig types. Using this property one can include/exclude specific routes in the generated _openapi.json.

To only include a part of the backend one can do for example:

export default defineNitroConfig({
  experimental: {
    openAPI: true,
  },
  routeRules: {
    "*": {
      openAPIEnabled: false,
    },
    "/api/public/**": {
      openAPIEnabled: true,
    },
  },
});

It is also possible to override this rule using the routes meta, like:

// /api/public/exceptionRoute.ts

defineRouteMeta({
  openAPIEnabled: false
})

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@horvbalint horvbalint marked this pull request as ready for review November 18, 2024 13:30
@horvbalint horvbalint requested a review from pi0 as a code owner November 18, 2024 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant