use zod schema description when generating components instead of only .openapi #111
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
src/openapi-generator.ts
Outdated
|
|
||
| /** | ||
| * A description provided from .openapi() should be taken with higher | ||
| * precedence. Note that there is an overload of .describe() that uses |
There was a problem hiding this comment.
Shouldn't we remove the overload? What purpose does it have now?
There was a problem hiding this comment.
Well that is a good question. This is the better implementation in my opinion. In case someone uses the .describe code with extendZodWithOpenApi then this would also mean that you can do .openapi({ description: 'Description' }).describe('Alternative'). If there is no such implementation you cannot do it. Note: In my opinion it is also valid to do this: .describe('Description').openapi({ description: 'Alternative'}) => we cannot just say "zod describe is before openapi or the other way round".
AGalabov
deleted the
fix/#104-description-not-available-without-zod-overrides
branch
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.
No description provided.