You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2018/12/18 09:16:58 UTC

[camel] 03/11: CAMEL-12815 - Added correct documentation markers and regen

This is an automated email from the ASF dual-hosted git repository.

acosentino pushed a commit to branch sandbox/camel-3.x
in repository https://gitbox.apache.org/repos/asf/camel.git

commit 70797dfed844867e4c4009ad6fb624cfb73a0719
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Tue Dec 18 08:30:20 2018 +0100

    CAMEL-12815 - Added correct documentation markers and regen
---
 .../camel-iota/src/main/docs/iota-component.adoc   | 49 ++++++++++++----------
 1 file changed, 28 insertions(+), 21 deletions(-)

diff --git a/components/camel-iota/src/main/docs/iota-component.adoc b/components/camel-iota/src/main/docs/iota-component.adoc
index e8e0eea..97d59e7 100644
--- a/components/camel-iota/src/main/docs/iota-component.adoc
+++ b/components/camel-iota/src/main/docs/iota-component.adoc
@@ -25,44 +25,51 @@ for this component:
 iota:name?url=nodeurl[&moreOptions...]
 ---------------------------------------------------------------------------------------------------------------
 
-==== Path Parameters (1 parameters):
+=== Options
 
+// component options: START
+The IOTA component has no options.
+// component options: END
 
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *name* | *Required* Name of component to use. |  | String
-|===
+// endpoint options: START
+The IOTA endpoint is configured using URI syntax:
+
+----
+iota:name
+----
 
+with the following path and query parameters:
 
-==== Query Parameters (5 parameters):
+==== Path Parameters (1 parameters):
 
 
 [width="100%",cols="2,5,^1,2",options="header"]
 |===
 | Name | Description | Default | Type
-| *url* (common) | *Required* Node url |  | String
-| *operation* (producer) | *Required* Supported operations are 'sendTransfer', 'getNewAddress', 'getTransfers' |  | String
-| *tag* (producer) | TAG |  | String
-| *securityLevel* (producer) | Address security level | 1 | int
-| *minWeightMagnitude* (producer) | The minWeightMagnitude is the minimum number of zeroes that a proof-of-work output/transaction hash must end with to be considered valid by full nodes | 14 | int
-| *depth* (producer) | The depth determines how deep the tangle is analysed for getting Tips | 9 | int
+| *name* | *Required* Component name |  | String
 |===
-// endpoint options: END
-// spring-boot-auto-configure options: START
-=== Spring Boot Auto-Configuration
-
 
-The component supports 2 options, which are listed below.
 
+==== Query Parameters (10 parameters):
 
 
 [width="100%",cols="2,5,^1,2",options="header"]
 |===
 | Name | Description | Default | Type
-| *camel.component.iota.enabled* | Enable IOTA component | true | Boolean
-| *camel.component.iota.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean
+| *depth* (common) | The depth determines how deep the tangle is analysed for getting Tips | 9 | Integer
+| *minWeightMagnitude* (common) | The minWeightMagnitude is the minimum number of zeroes that a proof-of-work output/transaction hash must end with to be considered valid by full nodes | 14 | Integer
+| *operation* (common) | Supported operations are 'sendTransfer', 'getNewAddress' |  | String
+| *securityLevel* (common) | Address security level | 1 | Integer
+| *tag* (common) | TAG |  | String
+| *url* (common) | Node url |  | String
+| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
+| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |  | ExceptionHandler
+| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. |  | ExchangePattern
+| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean
 |===
+// endpoint options: END
+
+// spring-boot-auto-configure options: START
 // spring-boot-auto-configure options: END
 
 === Sample route
@@ -142,4 +149,4 @@ The following route defined in Spring XML retrieve transfers data
 === See also
 
 * https://www.iota.org/[IOTA website]
-* https://github.com/iotaledger/iota.lib.java[IOTA java lib]
\ No newline at end of file
+* https://github.com/iotaledger/iota.lib.java[IOTA java lib]