Description property for some connector configuration properties is not set correctly [DBZ-1520]
- Dominant language
- HTML
- Stars
- 6
- Forks
- 8
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 1
Description
Migrated from [DBZ-1520](https://issues.redhat.com/browse/DBZ-1520)
While I was working on a tool that generates for me the connector's configuration programmatically from connector's configuration {{ALL_FIELDS}} property, I realized there are some configuration properties their description field is not set correctly (e.g: https://github.com/debezium/debezium/blob/22e8397e6dfd05cb5850ac1342b3ba78a8b4b7cb/debezium-connector-mysql/src/main/java/io/debezium/connector/mysql/MySqlConnectorConfig.java#L700). Therefore, I think it would make sense to move the javadoc comment into the description field for these properties to ease parsing the configuration properties description programmatically.
FYI [~jpechane]
PS: I can send a PR to fix this minor issue as well :)
Contributor guide
Research direction
Start with MySqlConnectorConfig.java around the referenced line and inspect the connector configuration property definitions, comparing their Javadoc with the values exposed in each description field. Identify the affected properties across the relevant connector configuration classes; the work is done when programmatic parsing receives the intended descriptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- databases
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100