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

Support examples field in @ApiHeader #3037

Merged
merged 1 commit into from
Sep 17, 2024

Conversation

blended-bram
Copy link
Contributor

@blended-bram blended-bram commented Aug 12, 2024

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Other... Please describe:

What is the current behavior?

Closes #3036

What is the new behavior?

Setting the examples field in @ApiHeader will produce the example dropdown for that field in the swagger docs.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@blended-bram
Copy link
Contributor Author

Based on the source for @ApiParam and @ApiQuery, it seems unlikely that those would have the same problem because they spread the options into the docs, perhaps that would also be appropriate more than hand picking the fields as is done for @ApiHeader. Especially knowing that you can spread with the omit helper.

@kamilmysliwiec kamilmysliwiec merged commit 00a6b80 into nestjs:master Sep 17, 2024
1 check passed
@kamilmysliwiec
Copy link
Member

lgtm

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.

@ApiHeader does not support examples
2 participants