docs(pipes): example of zod validation on specific method parameter #3375
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.
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?
Current docs provide an example of the
ZodValidationPipeapplied to the entire method using theUsePipesdecorator. It is also possible to only apply to the body and allow other pipe validation for example for the route parameters.What is the new behavior?
Example included for applying
ZodValidationPipeonly to the request body alongside route paramater validation viaParseIntPipe.Does this PR introduce a breaking change?
Other information
This is good to include as having both a route parameter and a Zod validated request body is a common use case.
Attempting to extend the existing example with a route parameter will apply the
ZodValidationPipeto the route parameter. This causes an HTTP 400 request to be returned (the route parameter will be anumbernot anobjectand will therefore fail Zod validation).Screenshot:
