This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push:
new e1db679 Fix up documentation of Camel Milo
e1db679 is described below
commit e1db679673a424345e7c1574a1ab5e23276aeedc
Author: Jens Reimann <jreim...@redhat.com>
AuthorDate: Thu Feb 22 10:44:46 2018 +0100
Fix up documentation of Camel Milo
This change fixes up the documentation of the camel-milo component. This
includes a fix of the node id table, which was rendered in a corrupt
format.
---
.../src/main/docs/milo-client-component.adoc | 30 +++++++++++-----------
.../src/main/docs/milo-server-component.adoc | 6 ++---
2 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/components/camel-milo/src/main/docs/milo-client-component.adoc
b/components/camel-milo/src/main/docs/milo-client-component.adoc
index f7671c9..a911e3f 100644
--- a/components/camel-milo/src/main/docs/milo-client-component.adoc
+++ b/components/camel-milo/src/main/docs/milo-client-component.adoc
@@ -40,7 +40,7 @@ The OPC UA Client component supports 6 options which are
listed below.
-### URI format
+=== URI format
The URI syntax of the endpoint is:
@@ -57,7 +57,7 @@
milo-client:tcp://[user:password@]host:port?node=RAW(nsu=urn:foo:bar;s=item-1)
If no user credentials are provided the client will switch to anonymous mode.
-### URI options
+=== URI options
All configuration options in the group +client+ are applicable to the shared
client instance. Endpoints
will share client instances for each endpoint URI. So the first time a request
for that endpoint URI is
@@ -130,7 +130,7 @@ with the following path and query parameters:
-#### Node ID
+==== Node ID
In order to define a target node a namespace and node id is required. In
previous versions this was possible by
@@ -143,25 +143,25 @@ The syntax of this node format is a set of `key=value`
pairs delimited by a semi
Exactly one namespace and one node id key must be used. See the following
table for possible keys:
-[width="100%",cols="2s,1,1m,1m,5",options="header"]
-|=======================================================================
+[width="100%",cols="2,2,5",options="header"]
+|===
| Key | Type | Description
-| ns | namespace | Numeric namespace index
-| nsu | namespace | Namespace URI
-| s | node | String node ID
-| i | node | Numeric node ID
-| g | node | GUID/UUID node ID
-| b | node | Base64 encoded string for opaque node ID
-|=======================================================================
+| *ns* | namespace | Numeric namespace index
+| *nsu* | namespace | Namespace URI
+| *s* | node | String node ID
+| *i* | node | Numeric node ID
+| *g* | node | GUID/UUID node ID
+| *b* | node | Base64 encoded string for opaque node ID
+|===
-As the values generated by the syntax cannot be transparently encoded into a
URI parameter value, it is necessary to escape
-them. However Camel allows to wrap the actual value inside `RAW(…)`, which
makes escaping unnecessary. For example:
+As the values generated by the syntax cannot be transparently encoded into a
URI parameter value, it is necessary to escape them.
+However Camel allows to wrap the actual value inside `RAW(…)`, which makes
escaping unnecessary. For example:
------------------------
milo-client://user:password@localhost:12345?node=RAW(nsu=http://foo.bar;s=foo/bar)
------------------------
-### See Also
+=== See Also
* Configuring Camel
* Component
diff --git a/components/camel-milo/src/main/docs/milo-server-component.adoc
b/components/camel-milo/src/main/docs/milo-server-component.adoc
index a93b17c..c095d1b 100644
--- a/components/camel-milo/src/main/docs/milo-server-component.adoc
+++ b/components/camel-milo/src/main/docs/milo-server-component.adoc
@@ -63,14 +63,14 @@ The OPC UA Server component supports 19 options which are
listed below.
-### URI format
+=== URI format
[source,java]
------------------------
milo-server:itemId[?options]
------------------------
-### URI options
+=== URI options
@@ -108,7 +108,7 @@ with the following path and query parameters:
-### See Also
+=== See Also
* Configuring Camel
* Component
--
To stop receiving notification emails like this one, please contact
davscl...@apache.org.
