8000 refactor(openapi): allow extensible `x-` properties in `$globals` by mukundshah Β· Pull Request #3278 Β· nitrojs/nitro Β· GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

refactor(openapi): allow extensible x- properties in $globals #3278

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

Merged
merged 3 commits into from
Apr 3, 2025

Conversation

mukundshah
Copy link
Contributor
@mukundshah mukundshah commented Apr 3, 2025

πŸ”— Linked issue

❓ 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 change enables the use of custom attributes, such as x-tagGroups, within the OpenAPI $globals section. This is particularly useful for tools like [Scalar](scalar/scalar#1016), where x-tagGroups allows for better organization of tags into logical groups, improving readability and navigation.

πŸ“ Checklist

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

@mukundshah mukundshah requested a review from pi0 as a code owner April 3, 2025 09:46
@mukundshah mukundshah changed the base branch from main to v2 April 3, 2025 09:46
@mukundshah mukundshah changed the title feat: allow extensible properties in OpenAPI $globals feat: allow extensible properties in OpenAPI $globals Apr 3, 2025
@pi0
Copy link
Member
pi0 commented Apr 3, 2025

Can you please write description (why, example).

@mukundshah
Copy link
Contributor Author

@pi0 I have now updated the description.

8000

@pi0 pi0 changed the title feat: allow extensible properties in OpenAPI $globals feat(openapi): allow extensible x- properties in $globals Apr 3, 2025
@pi0 pi0 changed the title feat(openapi): allow extensible x- properties in $globals refactor(openapi): allow extensible x- properties in $globals Apr 3, 2025
Copy link
Member
@pi0 pi0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thnx!

@pi0 pi0 merged commit 4a31f6c into nitrojs:v2 Apr 3, 2025
4 checks passed
pi0 pushed a commit that referenced this pull request Apr 7, 2025
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.

3 participants
0