Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Bug]: The Documentation of @SchemaFieldNumber has the wrong type #30273

Closed
1 of 16 tasks
iht opened this issue Feb 9, 2024 · 2 comments
Closed
1 of 16 tasks

[Bug]: The Documentation of @SchemaFieldNumber has the wrong type #30273

iht opened this issue Feb 9, 2024 · 2 comments
Labels
awaiting triage bug java P3
Milestone
2.58.0 Release

Comments

@iht
Copy link
Contributor

iht commented Feb 9, 2024

What happened?

The annotation @SchemaFieldNumber expects a String, but the documentation shows an example using integers.

This is how that annotation is used (with parseInt applied to a String), and here is an example in the repo actually using String and not integers.

This is a documentation-only bug.

Issue Priority

Priority: 3 (minor)

Issue Components

  • Component: Python SDK
  • Component: Java SDK
  • Component: Go SDK
  • Component: Typescript SDK
  • Component: IO connector
  • Component: Beam YAML
  • Component: Beam examples
  • Component: Beam playground
  • Component: Beam katas
  • Component: Website
  • Component: Spark Runner
  • Component: Flink Runner
  • Component: Samza Runner
  • Component: Twister2 Runner
  • Component: Hazelcast Jet Runner
  • Component: Google Cloud Dataflow Runner
bzablocki added a commit to bzablocki/beam that referenced this issue Feb 9, 2024
@bzablocki
Update documentation of @SchemaFieldNumber (apache#30273)
9457f38
@bzablocki bzablocki mentioned this issue Feb 9, 2024
Merged
3 tasks
robertwb pushed a commit that referenced this issue Apr 18, 2024
@bzablocki
Update documentation of @SchemaFieldNumber (#30273) (#30277)
61153bb
@Amar3tto
Copy link
Contributor

Amar3tto commented Jul 1, 2024

Can the issue be closed?
2.57 documentation seems correct

@iht
Copy link
Contributor Author

iht commented Jul 1, 2024

Fixed elsewhere

@iht iht closed this as completed Jul 1, 2024
@github-actions github-actions bot added this to the 2.58.0 Release milestone Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
awaiting triage bug java P3
Projects
None yet
Milestone
2.58.0 Release
Development

No branches or pull requests
2 participants
@iht @Amar3tto