Fix the blueprint for pydantic version 2 #1030
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.
Use the proper
ref_template
, specifying the{model}
in the template.An example is documented here: https://github.com/pydantic/pydantic/blob/main/docs/usage/json_schema.md#schema-customization
We need to specify
ref_template = '#/components/schemas/{model}'
, notref_template = '#/components/schemas/'
(need that extra{model}
at the end).model_json_schema
generates something like this, for aParent
model with achild
field of typeChild
:The definitions are in a key
$defs
(notdefinitions
), and the references start with#/components/schemas
as expected.