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: openapi tag support #1382

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

acdn-tsmith
Copy link

@acdn-tsmith acdn-tsmith commented Apr 24, 2024

Motivation and Context

Currently, in the sdk's generated wundergraph.openapi.json spec, all operations appear under a Default tag section in an openapi swagger viewer. This change enhances the openapi builder spec generation by adding tag support.

Before After
Screenshot 2024-04-24 at 9 53 50 AM Screenshot 2024-04-24 at 9 53 40 AM

With this enhancement, if a user enables openApi.enableTagAutoGrouping in the configureWundergraphApplication options, operations are organically grouped according to their uppermost ancestor folder (grandparent for operations/grandparent/parent/foo and parent for operations/parent/foo. There is also the option to override this and/or customize tags in the typescript operations with the tags parameter.

Marketing Changelog

Generated OpenAPI Spec Improvement: Tags

Checklist

Copy link

vercel bot commented Apr 24, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
wundergraph-docs-v3 ⬜️ Ignored (Inspect) Visit Preview Apr 24, 2024 4:50pm

Copy link

vercel bot commented Apr 24, 2024

@acdn-tsmith is attempting to deploy a commit to the WunderGraph Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

stale bot commented May 15, 2024

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added meta: stale and removed meta: stale labels May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant