fix: apply description and default metadata to enum, const, and not schemas in fromJSONSchema#5758
Open
mibragimov wants to merge 1 commit intocolinhacks:mainfrom
Open
Conversation
… fromJSONSchema Fixes colinhacks#5732 Early returns for enum, const, and not: {} (never) schemas in convertBaseSchema() bypassed the metadata application block at the end of the function. Extract metadata application into a helper function applyBaseMetadata() and call it from each of the affected early-return paths so that description and default are consistently honored across all schema types.
This file contains hidden or 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
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.
Problem
z.fromJSONSchema()ignoresdescriptionanddefaultfields when the JSON Schema usesenum,const, ornot: {}(never). This happens because these paths use early returns inconvertBaseSchema()before reaching the metadata application block at the bottom of the function.Minimal reproduction:
Fixes #5732
Solution
Extract the metadata application (description + default) into a helper function
applyBaseMetadata()and call it from each of the affected early-return paths:not: {}→z.never()enum→z.enum()/z.literal()/z.union()const→z.literal()Tests
Added five new tests covering:
descriptionon enum schemadescriptionon const schemadescriptionon not: {} (never) schemadefaulton enum schemadefaulton const schema