You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by "Polber (via GitHub)" <gi...@apache.org> on 2024/10/14 23:10:31 UTC
[PR] Propogate field_descriptions to RowTypeConstraint [beam]
Polber opened a new pull request, #32776:
URL: https://github.com/apache/beam/pull/32776
#29561 introduced the ability to persist Field descriptions defined in Cross-language transform configs as shown here: https://github.com/apache/beam/blob/80c7450f77f58c9e02087cc578ad8abe07648736/sdks/python/apache_beam/typehints/schemas.py#L546-L570
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` to `schema_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:
- [ ] Mention the appropriate issue in your description (for example: `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, comment `fixes #<ISSUE NUMBER>` instead.
- [ ] Update `CHANGES.md` with noteworthy changes.
- [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://github.com/apache/beam/blob/master/CONTRIBUTING.md#make-the-reviewers-job-easier).
To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md)
GitHub Actions Tests Status (on master branch)
------------------------------------------------------------------------------------------------
[](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Go+tests%22+branch%3Amaster+event%3Aschedule)
See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI or the [workflows README](https://github.com/apache/beam/blob/master/.github/workflows/README.md) to see a list of phrases to trigger workflows.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Propogate field_descriptions to RowTypeConstraint [beam]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #32776:
URL: https://github.com/apache/beam/pull/32776#issuecomment-2412494777
Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment `assign set of reviewers`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Propogate field_descriptions to RowTypeConstraint [beam]
Posted by "Polber (via GitHub)" <gi...@apache.org>.
Polber commented on PR #32776:
URL: https://github.com/apache/beam/pull/32776#issuecomment-2412493147
R: @robertwb
This PR fixes the issue with YAML auto docs not pulling in Java transform parameter descriptions.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Propogate field_descriptions to RowTypeConstraint [beam]
Posted by "robertwb (via GitHub)" <gi...@apache.org>.
robertwb merged PR #32776:
URL: https://github.com/apache/beam/pull/32776
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org