From b595302f9ca1d776e61e231b80da94fcecf92c9e Mon Sep 17 00:00:00 2001 From: Soby Chacko Date: Fri, 8 Mar 2024 15:50:38 -0500 Subject: [PATCH] Cleanup default properties docs Resolves https://github.com/spring-cloud/spring-cloud-stream/issues/2906 --- .../ROOT/pages/kafka/kafka-binder/config-options.adoc | 11 ++++------- .../pages/spring-cloud-stream/binding-properties.adoc | 2 +- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/modules/ROOT/pages/kafka/kafka-binder/config-options.adoc b/docs/modules/ROOT/pages/kafka/kafka-binder/config-options.adoc index 7856b93e6..3acbae24c 100644 --- a/docs/modules/ROOT/pages/kafka/kafka-binder/config-options.adoc +++ b/docs/modules/ROOT/pages/kafka/kafka-binder/config-options.adoc @@ -136,12 +136,10 @@ Default: false [[kafka-consumer-properties]] == Kafka Consumer Properties +The following properties are available for Kafka consumers only and must be prefixed with `spring.cloud.stream.kafka.bindings..consumer.`. + NOTE: To avoid repetition, Spring Cloud Stream supports setting values for all channels, in the format of `spring.cloud.stream.kafka.default.consumer.=`. - -The following properties are available for Kafka consumers only and -must be prefixed with `spring.cloud.stream.kafka.bindings..consumer.`. - admin.configuration:: Since version 2.1.1, this property is deprecated in favor of `topic.properties`, and support for it will be removed in a future version. @@ -307,12 +305,11 @@ Default: none. [[kafka-producer-properties]] == Kafka Producer Properties -NOTE: To avoid repetition, Spring Cloud Stream supports setting values for all channels, in the format of `spring.cloud.stream.kafka.default.producer.=`. - - The following properties are available for Kafka producers only and must be prefixed with `spring.cloud.stream.kafka.bindings..producer.`. +NOTE: To avoid repetition, Spring Cloud Stream supports setting values for all channels, in the format of `spring.cloud.stream.kafka.default.producer.=`. + admin.configuration:: Since version 2.1.1, this property is deprecated in favor of `topic.properties`, and support for it will be removed in a future version. diff --git a/docs/modules/ROOT/pages/spring-cloud-stream/binding-properties.adoc b/docs/modules/ROOT/pages/spring-cloud-stream/binding-properties.adoc index 2a7013f3f..38c2d4d9b 100644 --- a/docs/modules/ROOT/pages/spring-cloud-stream/binding-properties.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-stream/binding-properties.adoc @@ -14,7 +14,7 @@ public Function uppercase() { ---- there are two bindings named `uppercase-in-0` for input and `uppercase-out-0` for output. See <> for more details. -To avoid repetition, Spring Cloud Stream supports setting values for all bindings, in the format of `spring.cloud.stream.default.=` +NOTE: To avoid repetition, Spring Cloud Stream supports setting values for all bindings, in the format of `spring.cloud.stream.default.=` and `spring.cloud.stream.default..=` for common binding properties. When it comes to avoiding repetitions for extended binding properties, this format should be used - `spring.cloud.stream..default..=`.