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

fix(core): allow the apibody decorator to add examples and add $ref f… #1268

Merged
merged 1 commit into from
Jun 18, 2021
Merged

fix(core): allow the apibody decorator to add examples and add $ref f… #1268

merged 1 commit into from
Jun 18, 2021

Conversation

konne
Copy link
Contributor

@konne konne commented Mar 23, 2021

…or schema

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[X] 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?

Issue Number: #1073

The ApiBody decorator does not allow to add an examples section
and the schema option does not allow to use a $ref

The issue that @Body overrides all this information from the @ApiOperations
decorator is still an issue, but defining this information in the ApiBody is a
good workaround

What is the new behavior?

The ApiBody uses the examples section and allow a $ref type.

Does this PR introduce a breaking change?

[ ] Yes
[X] No

@konne
Copy link
Contributor Author

konne commented May 16, 2021

@kamilmysliwiec please can you pick up that PR or route it to somebody else so that this can be merged into the repo

@jmcdo29
Copy link
Member

jmcdo29 commented May 16, 2021

We're currently focused on the v8 release. As soon as v8 is released we will look into getting this merged. Apologies for the wait

@konne
Copy link
Contributor Author

konne commented May 16, 2021

@jmcdo29 thanks for the update

@kamilmysliwiec kamilmysliwiec merged commit 8e89351 into nestjs:master Jun 18, 2021
@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