#115 added support for ZodPipeline #118
Merged
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
Closed
georgyangelov
approved these changes
Apr 18, 2023
spec/modifiers/pipe.spec.ts
Outdated
| describe('pipe', () => { | ||
| z.string() | ||
| .transform(val => val.length) | ||
| .pipe(z.number().min(5)); |
There was a problem hiding this comment.
What's the problem?
There was a problem hiding this comment.
I got what the problem is 😄
| @@ -974,6 +974,10 @@ export class OpenAPIGenerator { | |||
| }; | |||
| } | |||
|
|
|||
| if (isZodType(zodSchema, 'ZodPipeline')) { | |||
| return this.toOpenAPISchema(zodSchema._def.in, isNullable, defaultValue); | |||
There was a problem hiding this comment.
Well this was easy 😄
There was a problem hiding this comment.
Are you sure that in is the right thing to use here?
I would expect something like this:
- Use
inforparametersas this is the possible input, from which an instance can be created - Use
outforschemasas this is the resulting type that will come out
|
@georgyangelov well I am not sure what the problem was to be honest. It might have been "fixed"/resolved by zod from then. From what I see and was even mentioned in another issue we can just use |
…o feature/#115-add-support-for-zod-pipelines
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.
Based on the documentation it seems that we can generate a documentation for
ZodPipeline.However we do have two options:
inproperty saved within the zod schema (done in the PR). My thought process was that this is what an API would receive when this schema is used for validation.outproperty as it describes the target state (might not always be the case).Overall I feel like
inis the only correct option we can use. But saying that it does bring up the question why cannot we just use the same logic when handling the result of.transform(). @georgyangelov any thoughts would be appreciated.