feat: support metadata #411
Open
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
…ish, nonNullishAsync, nonOptional, and nonOptionalAsync schemas
…redAsync, pickAsync, and merge methods
|
Thank you for creating this PR. I will review it in the next weeks. |
|
I will review this PR this week or next week. But I am still not sure if I want to merge it. |
|
@fabian-hiller Thank you! I think metadata is an essential feature, and both yup and zod support it. Do you think metadata needs to be discussed in more depth in terms of implementation? Do we need to consider the placement of metadata settings or the built-in metadata field? |
|
I am currently focused on other stuff. I will get back to you on the weekend or next week. |
fabian-hiller
force-pushed
the
main
branch
7 times, most recently
from
b997a0f
to
6d0cde4
Compare
|
Metadata would be super nice for exporting schemas to other formats like OpenAPI. |
|
Can you make an example with dummy code? |
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.
Implements #373
All schema functions accept the metadata argument:
message.any(),unknown(),recursive()The metadata argument has been added to the following method:
merge()omit()partial()pick()required()Use
isSchemainrestAndDefaultArgsto distinguish whether an object is a valid schema or metadata.Currently only the
descriptionfield has been added to the metadata.We can either follow the json-schema completely, or not pre-populate any fields like yup, or just a built-in
descriptionfield like zod.