gnodet-bot commented on code in PR #27495:
URL: https://github.com/apache/camel/pull/27495#discussion_r4216136500
##########
components/camel-kafka-common/src/main/java/org/apache/camel/component/kafka/KafkaClientConfiguration.java:
##########
@@ -328,8 +328,10 @@ public abstract class KafkaClientConfiguration implements
Cloneable, HeaderFilte
+ " in Camel configurations), the properties have
to be prefixed with additionalProperties., e.g.:"
+ "
additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://lo";
+ "calhost:8811/avro. If the properties are set in
the application.properties file, they must be "
- + "prefixed with
camel.component.kafka.additional-properties followed by the property name "
- + "enclosed in square brackets, for example the
delivery.timeout.ms property in square brackets.")
+ + "prefixed with
camel.component.kafka.additional-properties "
+ +
"(camel.component.kafka-share.additional-properties for the Kafka Share
component) followed by "
Review Comment:
📝 **Nit:** This description is on the shared `KafkaClientConfiguration` base
class, so the kafka-share parenthetical leaks into the regular `camel-kafka`
component's documentation (and catalog `kafka.json`). Since
`KafkaShareConfiguration` extends this class without overriding
`additionalProperties`, the generated docs for the `kafka` component will
mention `camel.component.kafka-share.additional-properties`, which is confusing
for kafka-only users.
Consider keeping this Javadoc component-agnostic ("see your component's
prefix") or overriding `additionalProperties` in `KafkaShareConfiguration` with
a component-specific `@UriParam` description.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
