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

Feature Request: Add Support for Request Entity Examples in @nestjs/swagger #24

Open
shravan20 opened this issue Feb 1, 2024 · 0 comments
Labels
approved-by-team backend community documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed medium-priority

Comments

@shravan20
Copy link
Owner

Feature Description

Add Support for Request Entity Examples in @nestjs/swagger

Proposed Solution

  • Adding support for including examples in the Swagger documentation for request entities.
  • Examples would be helpful for users to understand the expected format of the request bodies.

Example Usage

@ApiProperty({ example: { title: 'Example Product', description: 'Sample product description', categories: ['Category1', 'Category2'], ... } })
createProductDto: CreateProductDto;

Dependencies

Necessary dependencies are added, you can take a look into existing ProductController for reference

@shravan20 shravan20 added enhancement New feature or request team-review-required documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers medium-priority approved-by-team backend community and removed team-review-required labels Feb 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved-by-team backend community documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed medium-priority
Projects
None yet
Development

No branches or pull requests

1 participant