fix: required fields in nested pydantic models need to follow parent nullability #2199
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.
Description
Fields of nested pydantic models that are not kept as JSON via
skip_nested_types=True
need to follow the "requiredness" of their parent.Example:
results in a table that looks like this:
table
B
:which is incorrect as I can serialize an instance of
B
that does not have achild_a
, and thus, by extension, noid
forchild_a
.The change in this pull request retains the nullability of the field that contains the nested model, effectively making any required field of a nested, flattened model nullable as well if the parent model field is optional, i.e. the resulting table with the change in this PR is:
table
B
:If we agree this is a bug and the fix in this PR is the way to go I can add a test & fix for deeply nested models as well.