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 3a9e8701ffc0 Fix component docs that reference endpoint options which
do not exist (#29471)
3a9e8701ffc0 is described below
commit 3a9e8701ffc0fda57fa8856dcec4ff8b4fb9c50b
Author: dhairya05 <[email protected]>
AuthorDate: Mon Nov 9 19:19:10 2026 +0530
Fix component docs that reference endpoint options which do not exist
(#29471)
---
.../resources/org/apache/camel/catalog/docs/cometd-component.adoc | 4 ++--
.../resources/org/apache/camel/catalog/docs/mongodb-component.adoc | 2 +-
.../resources/org/apache/camel/catalog/docs/netty-component.adoc | 6 +-----
.../resources/org/apache/camel/catalog/docs/stitch-component.adoc | 4 ++--
.../resources/org/apache/camel/catalog/docs/timer-component.adoc | 2 +-
components/camel-cometd/src/main/docs/cometd-component.adoc | 4 ++--
components/camel-mongodb/src/main/docs/mongodb-component.adoc | 2 +-
components/camel-netty/src/main/docs/netty-component.adoc | 6 +-----
components/camel-stitch/src/main/docs/stitch-component.adoc | 4 ++--
components/camel-timer/src/main/docs/timer-component.adoc | 2 +-
10 files changed, 14 insertions(+), 22 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/cometd-component.adoc
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/cometd-component.adoc
index 8a26cd30d024..adc1a5f5170f 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/cometd-component.adoc
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/cometd-component.adoc
@@ -59,9 +59,9 @@ include::partial$component-endpoint-headers.adoc[]
Below, you can find some examples of how to pass the parameters.
-For file, for webapp resources located in the Web Application directory -->
`cometd://localhost:8080?resourceBase=file./webapp`.
+For file, for webapp resources located in the Web Application directory -->
`cometd://localhost:8080?baseResource=file:./webapp`.
-For classpath, when, for example, the web resources are packaged inside the
webapp folder --> `cometd://localhost:8080?resourceBase=classpath:webapp`
+For classpath, when, for example, the web resources are packaged inside the
webapp folder --> `cometd://localhost:8080?baseResource=classpath:webapp`
The following routes publish a message to the `/channel/orders` channel every
five seconds, and receive the messages
of that channel:
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/mongodb-component.adoc
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/mongodb-component.adoc
index 4b54aeb69976..59c089bb160c 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/mongodb-component.adoc
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/mongodb-component.adoc
@@ -999,7 +999,7 @@ cursor is to be regenerated, it will run the query with a
filter like:
`increasingField > lastValue`, so that only unread data is consumed.
*Setting the increasing field:* Set the key of the increasing field on
-the endpoint URI `tailTrackingIncreasingField` option. In Camel 2.10, it
+the endpoint URI `tailTrackIncreasingField` option. In Camel 2.10, it
must be a top-level field in your data, as nested navigation for this
field is not yet supported. That is, the "timestamp" field is okay, but
`nested.timestamp` will not work. Please open a ticket in the Camel JIRA
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/netty-component.adoc
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/netty-component.adoc
index f270d1ad9dd8..354a07360f67 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/netty-component.adoc
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/netty-component.adoc
@@ -176,13 +176,9 @@ In certain cases, it may be necessary to add chains of
encoders and
decoders to the netty pipeline.
To add multiple codecs to a Camel netty endpoint, the `encoders` and
`decoders` uri parameters should be used.
-Like the `encoder` and `decoder` parameters they are used to supply
-references (lists of `ChannelUpstreamHandlers` and
+They are used to supply references (lists of `ChannelUpstreamHandlers` and
`ChannelDownstreamHandlers`) that should be added to the pipeline.
-Note that if encoders are specified, then the encoder param will be ignored,
-similarly for decoders and the decoder param.
-
[NOTE]
====
Read further about using <<Netty-NonShareableEncodersOrDecoders,non-shareable
encoders/decoders>>.
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/stitch-component.adoc
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/stitch-component.adoc
index ebec20288fa2..5459f7e10d44 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/stitch-component.adoc
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/stitch-component.adoc
@@ -87,11 +87,11 @@ from("direct:sendStitch")
Currently, the component supports the following types for the body message on
the producer side when producing a message to Stitch component:
* `org.apache.camel.component.stitch.client.models.StitchRequestBody`: This
represents this Stitch
https://www.stitchdata.com/docs/developers/import-api/api#batch-data--arguments[JSON
Message]. However,
-`StitchRequestBody` includes a type safe builder that helps on building the
request body. Please note that, `tableName`, `keyNames` and `schema` options
are no longer required if you send the
+`StitchRequestBody` includes a type safe builder that helps on building the
request body. Please note that, `tableName`, `keyNames` and `stitchSchema`
options are no longer required if you send the
data with `StitchRequestBody`, if you still set these options, they override
whatever being set in message body `StitchRequestBody`.
* `org.apache.camel.component.stitch.client.models.StitchMessage`: This
represents
https://www.stitchdata.com/docs/developers/import-api/api#message-object[this
Stitch message structure].
-If you choose to send your message as `StitchMessage`, *you will need* to add
`tableName`, `keyNames` and `schema` options to either the Exchange headers or
through the endpoint options.
+If you choose to send your message as `StitchMessage`, *you will need* to add
`tableName`, `keyNames` and `stitchSchema` options to either the Exchange
headers or through the endpoint options.
* `Map`: You can also send the data as `Map`, the data structure must follow
this
https://www.stitchdata.com/docs/developers/import-api/api#batch-data--arguments[JSON
Message] structure which is similar to
`StitchRequestBody` but with drawback losing on all the type safety builder
that is included with `StitchRequestBody`.
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/timer-component.adoc
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/timer-component.adoc
index d8683420afb0..cd5eea369729 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/timer-component.adoc
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/timer-component.adoc
@@ -55,7 +55,7 @@ to the `Exchange`:
|===
|Name |Type |Description
-|`Exchange.TIMER_NAME` |`String` |The value of the `name` option.
+|`Exchange.TIMER_NAME` |`String` |The value of the `timerName` option.
|`Exchange.TIMER_TIME` |`Date` |The value of the `time` option.
diff --git a/components/camel-cometd/src/main/docs/cometd-component.adoc
b/components/camel-cometd/src/main/docs/cometd-component.adoc
index 8a26cd30d024..adc1a5f5170f 100644
--- a/components/camel-cometd/src/main/docs/cometd-component.adoc
+++ b/components/camel-cometd/src/main/docs/cometd-component.adoc
@@ -59,9 +59,9 @@ include::partial$component-endpoint-headers.adoc[]
Below, you can find some examples of how to pass the parameters.
-For file, for webapp resources located in the Web Application directory -->
`cometd://localhost:8080?resourceBase=file./webapp`.
+For file, for webapp resources located in the Web Application directory -->
`cometd://localhost:8080?baseResource=file:./webapp`.
-For classpath, when, for example, the web resources are packaged inside the
webapp folder --> `cometd://localhost:8080?resourceBase=classpath:webapp`
+For classpath, when, for example, the web resources are packaged inside the
webapp folder --> `cometd://localhost:8080?baseResource=classpath:webapp`
The following routes publish a message to the `/channel/orders` channel every
five seconds, and receive the messages
of that channel:
diff --git a/components/camel-mongodb/src/main/docs/mongodb-component.adoc
b/components/camel-mongodb/src/main/docs/mongodb-component.adoc
index 4b54aeb69976..59c089bb160c 100644
--- a/components/camel-mongodb/src/main/docs/mongodb-component.adoc
+++ b/components/camel-mongodb/src/main/docs/mongodb-component.adoc
@@ -999,7 +999,7 @@ cursor is to be regenerated, it will run the query with a
filter like:
`increasingField > lastValue`, so that only unread data is consumed.
*Setting the increasing field:* Set the key of the increasing field on
-the endpoint URI `tailTrackingIncreasingField` option. In Camel 2.10, it
+the endpoint URI `tailTrackIncreasingField` option. In Camel 2.10, it
must be a top-level field in your data, as nested navigation for this
field is not yet supported. That is, the "timestamp" field is okay, but
`nested.timestamp` will not work. Please open a ticket in the Camel JIRA
diff --git a/components/camel-netty/src/main/docs/netty-component.adoc
b/components/camel-netty/src/main/docs/netty-component.adoc
index f270d1ad9dd8..354a07360f67 100644
--- a/components/camel-netty/src/main/docs/netty-component.adoc
+++ b/components/camel-netty/src/main/docs/netty-component.adoc
@@ -176,13 +176,9 @@ In certain cases, it may be necessary to add chains of
encoders and
decoders to the netty pipeline.
To add multiple codecs to a Camel netty endpoint, the `encoders` and
`decoders` uri parameters should be used.
-Like the `encoder` and `decoder` parameters they are used to supply
-references (lists of `ChannelUpstreamHandlers` and
+They are used to supply references (lists of `ChannelUpstreamHandlers` and
`ChannelDownstreamHandlers`) that should be added to the pipeline.
-Note that if encoders are specified, then the encoder param will be ignored,
-similarly for decoders and the decoder param.
-
[NOTE]
====
Read further about using <<Netty-NonShareableEncodersOrDecoders,non-shareable
encoders/decoders>>.
diff --git a/components/camel-stitch/src/main/docs/stitch-component.adoc
b/components/camel-stitch/src/main/docs/stitch-component.adoc
index ebec20288fa2..5459f7e10d44 100644
--- a/components/camel-stitch/src/main/docs/stitch-component.adoc
+++ b/components/camel-stitch/src/main/docs/stitch-component.adoc
@@ -87,11 +87,11 @@ from("direct:sendStitch")
Currently, the component supports the following types for the body message on
the producer side when producing a message to Stitch component:
* `org.apache.camel.component.stitch.client.models.StitchRequestBody`: This
represents this Stitch
https://www.stitchdata.com/docs/developers/import-api/api#batch-data--arguments[JSON
Message]. However,
-`StitchRequestBody` includes a type safe builder that helps on building the
request body. Please note that, `tableName`, `keyNames` and `schema` options
are no longer required if you send the
+`StitchRequestBody` includes a type safe builder that helps on building the
request body. Please note that, `tableName`, `keyNames` and `stitchSchema`
options are no longer required if you send the
data with `StitchRequestBody`, if you still set these options, they override
whatever being set in message body `StitchRequestBody`.
* `org.apache.camel.component.stitch.client.models.StitchMessage`: This
represents
https://www.stitchdata.com/docs/developers/import-api/api#message-object[this
Stitch message structure].
-If you choose to send your message as `StitchMessage`, *you will need* to add
`tableName`, `keyNames` and `schema` options to either the Exchange headers or
through the endpoint options.
+If you choose to send your message as `StitchMessage`, *you will need* to add
`tableName`, `keyNames` and `stitchSchema` options to either the Exchange
headers or through the endpoint options.
* `Map`: You can also send the data as `Map`, the data structure must follow
this
https://www.stitchdata.com/docs/developers/import-api/api#batch-data--arguments[JSON
Message] structure which is similar to
`StitchRequestBody` but with drawback losing on all the type safety builder
that is included with `StitchRequestBody`.
diff --git a/components/camel-timer/src/main/docs/timer-component.adoc
b/components/camel-timer/src/main/docs/timer-component.adoc
index d8683420afb0..cd5eea369729 100644
--- a/components/camel-timer/src/main/docs/timer-component.adoc
+++ b/components/camel-timer/src/main/docs/timer-component.adoc
@@ -55,7 +55,7 @@ to the `Exchange`:
|===
|Name |Type |Description
-|`Exchange.TIMER_NAME` |`String` |The value of the `name` option.
+|`Exchange.TIMER_NAME` |`String` |The value of the `timerName` option.
|`Exchange.TIMER_TIME` |`Date` |The value of the `time` option.
