🎨 Field()
supports json_schema_extra
for Pydantic v2
#1035
+7
−1
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.
According to what this link mentions,
PydanticV1's Field class supported passing arbitrary keyword arguments to the JSON schema. In SQLModel counterpart, it was supported by passing schema_extra (see this).
PydanticV2 still supports passing extra things to the JSON schema but in a slightly different way. One has to pass a dictionary in the json_schema_extra argument (see this).
So I modified the Field's parameters to be compatible and consistent with the
Pydantic v2
parameters, and for backward compatibility, I didn't remove theschema_extra
field, which is logically compatible with both theschema_extra
andjson_schema_extra
passes, andschema_extra
should be deprecated at some point in the future. field at some point in the future, but for nowschema_extra
should be retained.This Pull Reqeust is easy and simple, and easy to verify.