fix(decorators): forward all OpenAPI parameter fields in @ApiHeader#3870
Merged
kamilmysliwiec merged 1 commit intonestjs:masterfrom Apr 22, 2026
Merged
Conversation
ApiHeader only propagated `description`, `required`, `examples` and
`schema` onto the generated parameter metadata, silently dropping the
other OpenAPI parameter fields defined on BaseParameterObject:
`deprecated`, `allowEmptyValue`, `style`, `explode`, `allowReserved`
and `content`. Users passing these options saw them disappear from
the generated OpenAPI document with no warning.
Forward the missing fields through to the parameter metadata so they
reach the explorer. Also avoid emitting the synthetic
`schema: { type: 'string' }` when the caller has supplied `content`,
since `schema` and `content` are mutually exclusive per the OpenAPI
Parameter Object spec.
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.
What kind of change does this PR introduce?
Bug fix.
What is the current behavior?
@ApiHeaderonly forwardeddescription,required,examplesandschemaonto the generated parameter metadata. The remaining OpenAPI Parameter Object fields it advertises viaApiHeaderOptions extends Omit<ParameterObject, 'in'>—deprecated,allowEmptyValue,style,explode,allowReserved,content— were silently dropped.Minimal repro:
None of the flagged flags appear on the emitted parameter. A
content-only header additionally ended up with an unwanted syntheticschema: { type: 'string' }, which is invalid per OpenAPI (schemaandcontentare mutually exclusive on a Parameter Object).What is the new behavior?
BaseParameterObject(deprecated,allowEmptyValue,style,explode,allowReserved,content) are now forwarded into the parameter metadata.content, the defaultschema: { type: 'string' }is suppressed so the emitted parameter only carriescontent, matching the spec's mutual-exclusivity rule.schema: { type: 'string' }and the top-levelexamplemapping toschema.exampleboth still apply when nocontentis provided.Additional context
Added a dedicated
test/decorators/api-header.decorator.spec.tswith four regressions (simple header, fully-populated header,content-only header, top-levelexample). The existing swagger-explorerwhen headers are definedsuite continues to pass untouched.