estuary-cdk: remove default _meta value from document schemas#3211
Merged
estuary-cdk: remove default _meta value from document schemas#3211
_meta value from document schemas#3211Conversation
The CDK's `BaseDocument` was schematizing a default value for the `_meta` field, but Pydantic doesn't add default values when the `exclude_unset` argument is set to `True` during serialization. This caused issues with Dekaf, where the schema said a field would exist, but documents didn't actually contain that field. Removing the default annotation from the `BaseDocument` schema is the fastest, clearly ok way to fix this. Should the CDK inject a default `_meta` value into each document? Maybe, but doing so would take some more investigation & testing.
Alex-Bair
force-pushed
the
bair/estuary-cdk-remove-schematizing-default-meta
branch
from
0acc255 to
37b504d
Compare
Alex-Bair
commented
Aug 22, 2025
Alex-Bair
deleted the
bair/estuary-cdk-remove-schematizing-default-meta
branch
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
2 participants
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:
The CDK's
BaseDocumentwas schematizing a default value for the_metafield, but Pydantic doesn't add default values when theexclude_unsetargument is set toTrueduring serialization. This caused issues with Dekaf, where the schema said a field would exist, but documents didn't actually contain that field.Removing the default annotation from the
BaseDocumentschema is the fastest, clearly ok way to fix this. Should the CDK inject a default_metavalue into each document? Maybe, but doing so would take some more investigation & testing.Workflow steps:
(How does one use this feature, and how has it changed)
Documentation links affected:
(list any documentation links that you created, or existing ones that you've identified as needing updates, along with a brief description)
Notes for reviewers:
The PR is best reviewed commit-by-commit, since many snapshot files needed updated to not have a default annotation for
_meta.I also updated recently failing snapshots to ensure every connector gets built with the new "don't schematize a default
_metavalue" behavior.This change is