swagger icon indicating copy to clipboard operation
swagger copied to clipboard

feat(core): add decorator for response http status 425 : ApiTooEarlyResponse

Open mgohin opened this issue 1 year ago • 2 comments

PR Checklist

Please check if your PR fulfills the following requirements:

  • [x] The commit message follows our guidelines: https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md
  • [x] Tests for the changes have been added (for bug fixes / features)
  • [x] Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • [ ] Bugfix
  • [x] 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?

No decorator to add documentation about response with HTTP status 425 Too early

Issue Number: N/A

What is the new behavior?

Added the decorator @ApiTooEarlyResponse

Does this PR introduce a breaking change?

  • [ ] Yes
  • [x] No

Other information

I could not use the HttpStatus enum because it does not contain entry for 425 code.

mgohin avatar Feb 08 '24 14:02 mgohin

see https://github.com/nestjs/swagger/issues/1501#issuecomment-945644971

that's why I made this package: https://www.npmjs.com/package/nestjs-swagger-api-http-response-decorators

micalevisk avatar Mar 25 '24 22:03 micalevisk

Because I did a PR I'm hoping it'll be merged one day ... but thanks for your package, gonna use it right now ;)

mgohin avatar Mar 26 '24 08:03 mgohin

https://github.com/nestjs/swagger/pull/2836

kamilmysliwiec avatar Jul 01 '24 11:07 kamilmysliwiec

I checked the PR, and it does not contain the requested decorator, there is no 425 response status. @kamilmysliwiec

mgohin avatar Jul 15 '24 10:07 mgohin