This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new c1355f2da2c1 CAMEL-27362: camel-yaml-dsl - docs write option names in
camelCase (#30610)
c1355f2da2c1 is described below
commit c1355f2da2c1d81950c393158577e162349c185d
Author: Claus Ibsen <[email protected]>
AuthorDate: Sun Nov 22 20:19:36 2026 +0100
CAMEL-27362: camel-yaml-dsl - docs write option names in camelCase (#30610)
The section "Option names in dash form" said an option can be written as
service-class, but camel validate and the doc-example check of the catalog
reject that form. Write option names in camelCase, as the component docs
list them. The keys after a map-option prefix and the keys of a map value
are still passed on as written.
Co-Authored-By: Claude Opus 5.5 <[email protected]>
Signed-off-by: Claus Ibsen <[email protected]>
---
.../resources/org/apache/camel/catalog/docs/yaml-dsl.adoc | 10 +++++-----
dsl/camel-yaml-dsl/camel-yaml-dsl/src/main/docs/yaml-dsl.adoc | 10 +++++-----
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/yaml-dsl.adoc
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/yaml-dsl.adoc
index 04a4f765d5fc..0aee75e2984d 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/yaml-dsl.adoc
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/yaml-dsl.adoc
@@ -375,14 +375,14 @@ Because the keys use underscore, then they are quoted.
IMPORTANT: To use map values for parameters, then the `uri` must only refer to
the name of the component, ie `plc4x` and not `plc4x:foo`
-=== Option names in dash form
+=== Option names and map keys
-An option under `parameters` can be written in dash form, such as
`service-class`, which Camel uses as
-`serviceClass`. This is not done for the keys of a map option, because Camel
passes them on as they are written.
+Write an option under `parameters` in camelCase, as the documentation of the
component lists it, such as
+`serviceClass`.
A key can start with the prefix of a map option, such as `properties.` of the
CXF component or `scheduler.` of a
-polling consumer. Then only the prefix is turned into camelCase, and the rest
of the key is kept. The keys of a map
-value are kept as they are written as well.
+polling consumer. Then the rest of the key, after the prefix, is passed on as
it is written. The keys of a map value
+are passed on as they are written as well.
[source,yaml]
----
diff --git a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/main/docs/yaml-dsl.adoc
b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/main/docs/yaml-dsl.adoc
index 04a4f765d5fc..0aee75e2984d 100644
--- a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/main/docs/yaml-dsl.adoc
+++ b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/main/docs/yaml-dsl.adoc
@@ -375,14 +375,14 @@ Because the keys use underscore, then they are quoted.
IMPORTANT: To use map values for parameters, then the `uri` must only refer to
the name of the component, ie `plc4x` and not `plc4x:foo`
-=== Option names in dash form
+=== Option names and map keys
-An option under `parameters` can be written in dash form, such as
`service-class`, which Camel uses as
-`serviceClass`. This is not done for the keys of a map option, because Camel
passes them on as they are written.
+Write an option under `parameters` in camelCase, as the documentation of the
component lists it, such as
+`serviceClass`.
A key can start with the prefix of a map option, such as `properties.` of the
CXF component or `scheduler.` of a
-polling consumer. Then only the prefix is turned into camelCase, and the rest
of the key is kept. The keys of a map
-value are kept as they are written as well.
+polling consumer. Then the rest of the key, after the prefix, is passed on as
it is written. The keys of a map value
+are passed on as they are written as well.
[source,yaml]
----