Propogate field_descriptions to RowTypeConstraint #32776
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.
#29561 introduced the ability to persist Field descriptions defined in Cross-language transform configs as shown here:
beam/sdks/python/apache_beam/typehints/schemas.py
Lines 546 to 570 in 80c7450
However, this information is dropped when converting the NamedTuple (parsed from the proto) into a
RowTypeConstraint
type.This PR propagates this optional data so that when converting from
RowTypeConstraint
toschema_pb2.Schema
(runner_api), the field descriptions can be included in the proto.This is also helpful for Beam YAML auto documentation which attempts to use the description field from the
schema_pb2.Schema
, but is not populated by default. After this change, the auto documentation can pull in decsriptions for cross-language (Java) transforms annotated with@SchemaFieldDescription
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
addresses #123
), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>
instead.CHANGES.md
with noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.