Add a convenience type to override JSON schema #5788
Merged
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.
Closes #5096
Closes #4079
Introduces an annotation
WithJsonSchema
that you can use to override the JSON schema for a type.Also makes it so that if you raise
pydantic_core.PydanticOmit
while generating the JSON schema for a field of any type that has fields (i.e., model, dataclass, typeddict), that field is omitted from the generated JSON schema.The tests added to this PR demonstrate how to use this functionality to address:
Selected Reviewer: @samuelcolvin