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

docs(oas/swagger): provide examples of the example and examples keys #3026

Merged
merged 1 commit into from
Oct 18, 2024

Conversation

fbartkow-from-f
Copy link
Contributor

Provide examples to users on how to set example and examples keys in the @ApiProperty annotation

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
  • Docs
  • Other... Please describe:

What is the current behavior?

Currently the documentation does not have any indication of how to use the example or examples keys in the @ApiProperty(...) annotation.

Issue Number: N/A

What is the new behavior?

This PR adds an example for the example and an example for the examples keys to the documentation to help show how to use them.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

N/A - This is a pretty straightforward PR.

Provide examples to users on how to set example and examples keys in the @ApiProperty annotation
@kamilmysliwiec kamilmysliwiec merged commit 441f907 into nestjs:master Oct 18, 2024
4 checks 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.

3 participants