feat: Introduce @requestBody.file and @oas.response.file decorators #4882
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
raymondfeng
requested review from
agnes512,
bajtos,
deepakrkris,
emonddr,
hacksparrow,
jannyHou and
nabdelgadir
as code owners
4 tasks
jannyHou
reviewed
Mar 13, 2020
...penapi-v3/src/__tests__/unit/decorators/request-body/request-body-shortcut.decorator.unit.ts
Show resolved
Hide resolved
raymondfeng
force-pushed
the
openapi-file-decorators
branch
2 times, most recently
from
faf0c04 to
b94a29b
Compare
jannyHou
approved these changes
Mar 16, 2020
agnes512
reviewed
Mar 16, 2020
| @@ -357,6 +357,25 @@ class MyController { | |||
| } | |||
| ``` | |||
|
|
|||
| #### @requestBody.file | |||
There was a problem hiding this comment.
#### Using @requestBody.file ?
There was a problem hiding this comment.
Other titles don't have Using
emonddr
approved these changes
Mar 16, 2020
...penapi-v3/src/__tests__/unit/decorators/request-body/request-body-shortcut.decorator.unit.ts
Outdated
Show resolved
Hide resolved
raymondfeng
force-pushed
the
openapi-file-decorators
branch
from
b94a29b to
a6088a6
Compare
mschnee
approved these changes
Mar 16, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces two sugar openapi decorators to further simplify configuration of file upload/download.
@requestBody.file- configure the request body for file upload@oas.response.file- configure the response for file downloadThe file upload/download example is now simplified with these decorators.
A new page is added under
Usage Scenariosto cover file upload/download.Fixes #1873
Checklist
👉 Read and sign the CLA (Contributor License Agreement) 👈
npm testpasses on your machinepackages/cliwere updatedexamples/*were updated👉 Check out how to submit a PR 👈