From e407a9cf80b0c773afaff9404200e203b32df91c Mon Sep 17 00:00:00 2001 From: Soby Chacko Date: Tue, 18 Apr 2023 11:35:09 -0400 Subject: [PATCH] Clarify docs for binding keys with special chars Resolves https://github.com/spring-cloud/spring-cloud-stream/issues/2699 --- docs/src/main/asciidoc/spring-cloud-stream.adoc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/src/main/asciidoc/spring-cloud-stream.adoc b/docs/src/main/asciidoc/spring-cloud-stream.adoc index ea4a04730..bb8a567c7 100644 --- a/docs/src/main/asciidoc/spring-cloud-stream.adoc +++ b/docs/src/main/asciidoc/spring-cloud-stream.adoc @@ -273,6 +273,9 @@ Throughout this manual you will see examples of configuration properties such as The `input` segment in this property name is what we refer to as _binding name_ and it could derive via several mechanisms. The following sub-sections will describe the naming conventions and configuration elements used by spring-cloud-stream to control binding names. +NOTE: If your binding name has special characters, such as the `.` character, you need to surround the binding key with brackets (`[]`) and then wrap it in qoutes. +For example `spring.cloud.stream.bindings."[my.output.binding.key]".destination`. + ===== Functional binding names Unlike the explicit naming required by annotation-based support (legacy) used in the previous versions of spring-cloud-stream, the functional