gnodet-bot commented on code in PR #27488:
URL: https://github.com/apache/camel/pull/27488#discussion_r4206515121
##########
components/camel-kafka-common/src/main/java/org/apache/camel/component/kafka/AbstractKafkaComponent.java:
##########
@@ -39,13 +39,26 @@ public abstract class AbstractKafkaComponent extends
HealthCheckComponent
private final List<Runnable> pendingConsumers = new
CopyOnWriteArrayList<>();
- @Metadata(label = "security", defaultValue = "false")
+ @Metadata(label = "security", defaultValue = "false", description =
"Enable usage of global SSL context parameters.")
private boolean useGlobalSslContextParameters;
- @Metadata(autowired = true, label = "consumer,advanced")
+ @Metadata(autowired = true, label = "consumer,advanced",
+ description = "To use a custom strategy with the consumer to
control how to handle exceptions thrown from the "
+ + "Kafka broker while pooling messages.")
private PollExceptionStrategy pollExceptionStrategy;
Review Comment:
🔤 **Typo:** `pooling` → `polling`.
The field is `pollExceptionStrategy`, related to *polling* (fetching
messages from the broker), not *pooling* (resource pooling).
```suggestion
@Metadata(autowired = true, label = "consumer,advanced",
description = "To use a custom strategy with the consumer to
control how to handle exceptions thrown from the "
+ "Kafka broker while polling messages.")
```
##########
components/camel-kafka-common/src/main/java/org/apache/camel/component/kafka/KafkaClientConfiguration.java:
##########
@@ -215,16 +311,32 @@ public abstract class KafkaClientConfiguration implements
Cloneable, HeaderFilte
description = "OAuth scope. Used when saslAuthType is set to
OAUTH.")
private String oauthScope;
// Schema registry only options
- @UriParam(label = "schema")
+ @UriParam(label = "schema",
+ description = "URL of the schema registry servers to use. The
format is host1:port1,host2:port2. This is known"
+ + " as schema.registry.url in multiple Schema
registries documentation. This option is only "
+ + "available externally (not standard Apache
Kafka)")
private String schemaRegistryURL;
- @UriParam(label = "schema,consumer")
+ @UriParam(label = "schema,consumer",
+ description = "This enables the use of a specific Avro reader
for use with the in multiple Schema registries "
+ + "documentation with Avro Deserializers
implementation. This option is only available externally "
+ + "(not standard Apache Kafka)")
private boolean specificAvroReader;
// Additional properties
- @UriParam(label = "common", prefix = "additionalProperties.", multiValue =
true)
+ @UriParam(label = "common", prefix = "additionalProperties.", multiValue =
true,
+ description = "Sets additional properties for either kafka
consumer or kafka producer in case they can't be "
+ + "set directly on the camel configurations (e.g.:
new Kafka properties that are not reflected yet"
+ + " in Camel configurations), the properties have
to be prefixed with additionalProperties.., "
+ + "e.g.:
additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http"
+ + "://localhost:8811/avro. If the properties are
set in the application.properties file, they must"
+ + " be prefixed with
camel.component.kafka.additional-properties and the property enclosed in "
+ + "square brackets, like this example: "
+ +
"camel.component.kafka.additional-propertiesdelivery.timeout.ms=15000.")
private Map<String, Object> additionalProperties = new HashMap<>();
Review Comment:
🔤 **Missing brackets in example:** the description says properties must be
"enclosed in square brackets" but the example omits them.
It currently reads:
```
camel.component.kafka.additional-propertiesdelivery.timeout.ms=15000
```
It should be:
```
camel.component.kafka.additional-properties[delivery.timeout.ms]=15000
```
```suggestion
+
"camel.component.kafka.additional-properties[delivery.timeout.ms]=15000.")
```
--
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]
