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 f6c197f Polished doc
f6c197f is described below
commit f6c197f1cc670e495e06ca2819f8ad934fe58cea
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Thu Sep 2 15:50:54 2021 +0200
Polished doc
---
.../generated/resources/org/apache/camel/catalog/models/choice.json | 2 +-
.../resources/org/apache/camel/catalog/models/convertBodyTo.json | 1 +
.../resources/org/apache/camel/catalog/models/dynamicRouter.json | 4 ++--
.../resources/org/apache/camel/catalog/models/recipientList.json | 2 +-
.../src/main/docs/modules/eips/pages/choice-eip.adoc | 3 +--
.../src/main/docs/modules/eips/pages/convertBodyTo-eip.adoc | 3 ++-
.../src/main/docs/modules/eips/pages/dynamicRouter-eip.adoc | 4 ++--
.../src/main/docs/modules/eips/pages/recipientList-eip.adoc | 2 +-
.../src/generated/resources/org/apache/camel/model/choice.json | 2 +-
.../src/generated/resources/org/apache/camel/model/dynamicRouter.json | 2 +-
.../src/generated/resources/org/apache/camel/model/recipientList.json | 2 +-
.../src/main/java/org/apache/camel/model/ChoiceDefinition.java | 2 +-
.../src/main/java/org/apache/camel/model/DynamicRouterDefinition.java | 2 +-
.../src/main/java/org/apache/camel/model/RecipientListDefinition.java | 2 +-
14 files changed, 17 insertions(+), 16 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/choice.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/choice.json
index 4a1e131..e227b1b 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/choice.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/choice.json
@@ -3,7 +3,7 @@
"kind": "model",
"name": "choice",
"title": "Choice",
- "description": "Routes messages based on a series of predicates",
+ "description": "Route messages based on a series of predicates",
"deprecated": false,
"label": "eip,routing",
"javaType": "org.apache.camel.model.ChoiceDefinition",
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/convertBodyTo.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/convertBodyTo.json
index 448e03b..4b84803 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/convertBodyTo.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/convertBodyTo.json
@@ -12,6 +12,7 @@
},
"properties": {
"type": { "kind": "attribute", "displayName": "Type", "required": true,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "The java type to convert
to" },
+ "mandatory": { "kind": "attribute", "displayName": "Mandatory",
"required": false, "type": "boolean", "javaType": "java.lang.Boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": true,
"description": "When mandatory then the conversion must return a value (cannot
be null), if this is not possible then NoTypeConversionAvailableException is
thrown. Setting this to false could mean conversion is not possible and the
value is null." },
"charset": { "kind": "attribute", "displayName": "Charset", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "To use a specific charset
when converting" },
"id": { "kind": "attribute", "displayName": "Id", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "Sets the id of this node"
},
"description": { "kind": "element", "displayName": "Description",
"required": false, "type": "object", "javaType":
"org.apache.camel.model.DescriptionDefinition", "deprecated": false,
"autowired": false, "secret": false, "description": "Sets the description of
this node" }
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/dynamicRouter.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/dynamicRouter.json
index 67431d9..3025197 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/dynamicRouter.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/dynamicRouter.json
@@ -3,7 +3,7 @@
"kind": "model",
"name": "dynamicRouter",
"title": "Dynamic Router",
- "description": "Routes messages based on dynamic rules",
+ "description": "Route messages based on dynamic rules",
"deprecated": false,
"label": "eip,endpoint,routing",
"javaType": "org.apache.camel.model.DynamicRouterDefinition",
@@ -13,7 +13,7 @@
"properties": {
"expression": { "kind": "expression", "displayName": "Expression",
"required": true, "type": "object", "javaType":
"org.apache.camel.model.language.ExpressionDefinition", "oneOf": [ "constant",
"csimple", "datasonnet", "exchangeProperty", "groovy", "header", "hl7terser",
"joor", "jsonpath", "language", "method", "mvel", "ognl", "ref", "simple",
"spel", "tokenize", "xpath", "xquery", "xtokenize" ], "deprecated": false,
"autowired": false, "secret": false, "description": "Expression to [...]
"uriDelimiter": { "kind": "attribute", "displayName": "Uri Delimiter",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": ",",
"description": "Sets the uri delimiter to use" },
- "ignoreInvalidEndpoints": { "kind": "attribute", "displayName": "Ignore
Invalid Endpoints", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Ignore the invalidate endpoint exception when try to create a
producer with that endpoint" },
+ "ignoreInvalidEndpoints": { "kind": "attribute", "displayName": "Ignore
Invalid Endpoints", "required": false, "type": "boolean", "javaType":
"java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Ignore the invalidate endpoint exception
when try to create a producer with that endpoint" },
"cacheSize": { "kind": "attribute", "displayName": "Cache Size",
"required": false, "type": "integer", "javaType": "java.lang.Integer",
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the maximum size used by the org.apache.camel.spi.ProducerCache which is used
to cache and reuse producers when using this dynamic router, when uris are
reused. Beware that when using dynamic endpoints then it affects how well the
cache can be utilized. If each dynamic end [...]
"id": { "kind": "attribute", "displayName": "Id", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "Sets the id of this node"
},
"description": { "kind": "element", "displayName": "Description",
"required": false, "type": "object", "javaType":
"org.apache.camel.model.DescriptionDefinition", "deprecated": false,
"autowired": false, "secret": false, "description": "Sets the description of
this node" }
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/recipientList.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/recipientList.json
index 26915b4..c95e42d 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/recipientList.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/recipientList.json
@@ -3,7 +3,7 @@
"kind": "model",
"name": "recipientList",
"title": "Recipient List",
- "description": "Routes messages to a number of dynamically specified
recipients (dynamic to)",
+ "description": "Route messages to a number of dynamically specified
recipients (dynamic to)",
"deprecated": false,
"label": "eip,endpoint,routing",
"javaType": "org.apache.camel.model.RecipientListDefinition",
diff --git
a/core/camel-core-engine/src/main/docs/modules/eips/pages/choice-eip.adoc
b/core/camel-core-engine/src/main/docs/modules/eips/pages/choice-eip.adoc
index a431005..a2dfab4 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/choice-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/choice-eip.adoc
@@ -1,7 +1,7 @@
[[choice-eip]]
= Choice EIP
:docTitle: Choice
-:description: Routes messages based on a series of predicates
+:description: Route messages based on a series of predicates
:since:
:supportLevel: Stable
@@ -111,4 +111,3 @@ See
xref:latest@manual:faq:why-can-i-not-use-when-or-otherwise-in-a-java-camel-r
can I not use when or otherwise in a Java Camel route] if you have
problems with the Java DSL, accepting using `when` or `otherwise`.
====
-
diff --git
a/core/camel-core-engine/src/main/docs/modules/eips/pages/convertBodyTo-eip.adoc
b/core/camel-core-engine/src/main/docs/modules/eips/pages/convertBodyTo-eip.adoc
index b273146..8e9a0e84 100644
---
a/core/camel-core-engine/src/main/docs/modules/eips/pages/convertBodyTo-eip.adoc
+++
b/core/camel-core-engine/src/main/docs/modules/eips/pages/convertBodyTo-eip.adoc
@@ -8,12 +8,13 @@
The ConvertBodyTo EIP allows you to transform your body to a different type.
// eip options: START
-The Convert Body To EIP supports 2 options which are listed below:
+The Convert Body To EIP supports 3 options which are listed below:
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *type* | *Required* The java type to convert to | | String
+| *mandatory* | When mandatory then the conversion must return a value (cannot
be null), if this is not possible then NoTypeConversionAvailableException is
thrown. Setting this to false could mean conversion is not possible and the
value is null. | true | Boolean
| *charset* | To use a specific charset when converting | | String
|===
// eip options: END
diff --git
a/core/camel-core-engine/src/main/docs/modules/eips/pages/dynamicRouter-eip.adoc
b/core/camel-core-engine/src/main/docs/modules/eips/pages/dynamicRouter-eip.adoc
index 64a0fce..77afb8f 100644
---
a/core/camel-core-engine/src/main/docs/modules/eips/pages/dynamicRouter-eip.adoc
+++
b/core/camel-core-engine/src/main/docs/modules/eips/pages/dynamicRouter-eip.adoc
@@ -1,7 +1,7 @@
[[dynamicRouter-eip]]
= Dynamic Router EIP
:docTitle: Dynamic Router
-:description: Routes messages based on dynamic rules
+:description: Route messages based on dynamic rules
:since:
:supportLevel: Stable
@@ -43,7 +43,7 @@ The Dynamic Router EIP supports 3 options which are listed
below:
|===
| Name | Description | Default | Type
| *uriDelimiter* | Sets the uri delimiter to use | , | String
-| *ignoreInvalidEndpoints* | Ignore the invalidate endpoint exception when try
to create a producer with that endpoint | | String
+| *ignoreInvalidEndpoints* | Ignore the invalidate endpoint exception when try
to create a producer with that endpoint | false | Boolean
| *cacheSize* | Sets the maximum size used by the
org.apache.camel.spi.ProducerCache which is used to cache and reuse producers
when using this dynamic router, when uris are reused. Beware that when using
dynamic endpoints then it affects how well the cache can be utilized. If each
dynamic endpoint is unique then its best to turn of caching by setting this to
-1, which allows Camel to not cache both the producers and endpoints; they are
regarded as prototype scoped and will be stopped an [...]
|===
// eip options: END
diff --git
a/core/camel-core-engine/src/main/docs/modules/eips/pages/recipientList-eip.adoc
b/core/camel-core-engine/src/main/docs/modules/eips/pages/recipientList-eip.adoc
index c5cd4ed..8371309 100644
---
a/core/camel-core-engine/src/main/docs/modules/eips/pages/recipientList-eip.adoc
+++
b/core/camel-core-engine/src/main/docs/modules/eips/pages/recipientList-eip.adoc
@@ -1,7 +1,7 @@
[[recipientList-eip]]
= Recipient List EIP
:docTitle: Recipient List
-:description: Routes messages to a number of dynamically specified recipients
(dynamic to)
+:description: Route messages to a number of dynamically specified recipients
(dynamic to)
:since:
:supportLevel: Stable
diff --git
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/choice.json
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/choice.json
index 4a1e131..e227b1b 100644
---
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/choice.json
+++
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/choice.json
@@ -3,7 +3,7 @@
"kind": "model",
"name": "choice",
"title": "Choice",
- "description": "Routes messages based on a series of predicates",
+ "description": "Route messages based on a series of predicates",
"deprecated": false,
"label": "eip,routing",
"javaType": "org.apache.camel.model.ChoiceDefinition",
diff --git
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/dynamicRouter.json
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/dynamicRouter.json
index 345f21d..3025197 100644
---
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/dynamicRouter.json
+++
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/dynamicRouter.json
@@ -3,7 +3,7 @@
"kind": "model",
"name": "dynamicRouter",
"title": "Dynamic Router",
- "description": "Routes messages based on dynamic rules",
+ "description": "Route messages based on dynamic rules",
"deprecated": false,
"label": "eip,endpoint,routing",
"javaType": "org.apache.camel.model.DynamicRouterDefinition",
diff --git
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/recipientList.json
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/recipientList.json
index 26915b4..c95e42d 100644
---
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/recipientList.json
+++
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/recipientList.json
@@ -3,7 +3,7 @@
"kind": "model",
"name": "recipientList",
"title": "Recipient List",
- "description": "Routes messages to a number of dynamically specified
recipients (dynamic to)",
+ "description": "Route messages to a number of dynamically specified
recipients (dynamic to)",
"deprecated": false,
"label": "eip,endpoint,routing",
"javaType": "org.apache.camel.model.RecipientListDefinition",
diff --git
a/core/camel-core-model/src/main/java/org/apache/camel/model/ChoiceDefinition.java
b/core/camel-core-model/src/main/java/org/apache/camel/model/ChoiceDefinition.java
index bf3d5ea..18b78cd 100644
---
a/core/camel-core-model/src/main/java/org/apache/camel/model/ChoiceDefinition.java
+++
b/core/camel-core-model/src/main/java/org/apache/camel/model/ChoiceDefinition.java
@@ -36,7 +36,7 @@ import org.apache.camel.spi.Metadata;
import org.apache.camel.util.ObjectHelper;
/**
- * Routes messages based on a series of predicates
+ * Route messages based on a series of predicates
*/
@Metadata(label = "eip,routing")
@XmlRootElement(name = "choice")
diff --git
a/core/camel-core-model/src/main/java/org/apache/camel/model/DynamicRouterDefinition.java
b/core/camel-core-model/src/main/java/org/apache/camel/model/DynamicRouterDefinition.java
index 36a85b1..af27e05 100644
---
a/core/camel-core-model/src/main/java/org/apache/camel/model/DynamicRouterDefinition.java
+++
b/core/camel-core-model/src/main/java/org/apache/camel/model/DynamicRouterDefinition.java
@@ -29,7 +29,7 @@ import org.apache.camel.model.language.ExpressionDefinition;
import org.apache.camel.spi.Metadata;
/**
- * Routes messages based on dynamic rules
+ * Route messages based on dynamic rules
*/
@Metadata(label = "eip,endpoint,routing")
@XmlRootElement(name = "dynamicRouter")
diff --git
a/core/camel-core-model/src/main/java/org/apache/camel/model/RecipientListDefinition.java
b/core/camel-core-model/src/main/java/org/apache/camel/model/RecipientListDefinition.java
index 7fb784b..11781ac 100644
---
a/core/camel-core-model/src/main/java/org/apache/camel/model/RecipientListDefinition.java
+++
b/core/camel-core-model/src/main/java/org/apache/camel/model/RecipientListDefinition.java
@@ -33,7 +33,7 @@ import org.apache.camel.model.language.ExpressionDefinition;
import org.apache.camel.spi.Metadata;
/**
- * Routes messages to a number of dynamically specified recipients (dynamic to)
+ * Route messages to a number of dynamically specified recipients (dynamic to)
*/
@Metadata(label = "eip,endpoint,routing")
@XmlRootElement(name = "recipientList")
