nestjs / docs.nestjs.com

The official documentation https://docs.nestjs.com 📕
MIT License
1.13k stars 1.62k forks source link

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

Open fbartkow-from-f opened 1 month ago

fbartkow-from-f commented 1 month ago

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?

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?

Other information

N/A - This is a pretty straightforward PR.