feat(swagger): add summary field to Tag Object (OpenAPI 3.2)#3921
Merged
kamilmysliwiec merged 1 commit intoMay 20, 2026
Conversation
This was referenced May 19, 2026
Member
|
@copilot resolve the merge conflicts in this pull request |
OpenAPI 3.2 introduced three new fields on the Tag Object: parent, kind, and summary. PR nestjs#3725 added parent and kind support, but summary was omitted. This change adds it to the TagObject interface and exposes it via DocumentBuilder.addTag() options, matching the surface area of the existing hierarchy options. Per the spec, summary is "a short summary of the tag, used for display purposes" (https://spec.openapis.org/oas/v3.2.0.html#tag-object).
509d41c to
5dd7ce3
Compare
Contributor
Author
I've already updated it for you. Thanks |
Member
|
lgtm |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
OpenAPI 3.2 added three new fields to the Tag Object:
parent,kind, andsummary. PR #3725 added support forparentandkind, butsummarywas not included.Per the OpenAPI 3.2 spec:
What is the new behavior?
TagObjectinterface now includes optionalsummaryfield.DocumentBuilder.addTag()acceptssummaryin its 4th-parameter options object, alongside the existingparentandkind.ApiTagOptionsand the@ApiTags()decorator are intentionally not extended in this PR — their hierarchy metadata (parent/kind) is currently discarded (see the existing tests intest/decorators/api-use-tags.decorator.spec.tswhich assert this). I'll open a separate issue for that so it can be discussed independently.Does this PR introduce a breaking change?
Other information
Refs #3725.