This is an automated email from the ASF dual-hosted git repository.
orpiske 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 156db5c389f CAMEL-21040: ensure more consistency in the document
sections
156db5c389f is described below
commit 156db5c389f124abd657a336bf1a6204a5bf4e5b
Author: Otavio Rodolfo Piske <angusyo...@gmail.com>
AuthorDate: Wed Aug 7 10:28:30 2024 +0200
CAMEL-21040: ensure more consistency in the document sections
---
.../camel-ftp/src/main/docs/ftp-component.adoc | 32 +++++-----
.../camel-ftp/src/main/docs/sftp-component.adoc | 4 +-
.../camel-git/src/main/docs/git-component.adoc | 9 ++-
.../src/main/docs/github-component.adoc | 8 ++-
.../src/main/docs/google-bigquery-component.adoc | 10 +--
.../main/docs/google-pubsub-lite-component.adoc | 8 ++-
.../src/main/docs/google-pubsub-component.adoc | 14 +++--
.../src/main/docs/google-storage-component.adoc | 4 +-
.../camel-grok/src/main/docs/grok-dataformat.adoc | 6 +-
.../src/main/docs/groovy-language.adoc | 73 +++++++++++-----------
.../camel-grpc/src/main/docs/grpc-component.adoc | 10 +--
.../src/main/docs/guava-eventbus-component.adoc | 4 +-
.../src/main/docs/hashicorp-vault-component.adoc | 2 +
.../camel-headersmap/src/main/docs/headersmap.adoc | 4 +-
.../src/main/docs/hl7terser-language.adoc | 6 +-
15 files changed, 108 insertions(+), 86 deletions(-)
diff --git a/components/camel-ftp/src/main/docs/ftp-component.adoc
b/components/camel-ftp/src/main/docs/ftp-component.adoc
index 326dc60a3a1..9046f6b3e9c 100644
--- a/components/camel-ftp/src/main/docs/ftp-component.adoc
+++ b/components/camel-ftp/src/main/docs/ftp-component.adoc
@@ -91,7 +91,9 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== FTPS component default trust store
+== Usage
+
+=== FTPS component default trust store
When using the `ftpClient.` properties related to SSL with the FTPS
component, the trust store accepts all certificates. If you only want
@@ -150,7 +152,7 @@ url.
from("ftp://foo@myserver?password=secret&ftpClientConfig=#myConfig";).to("bean:foo");
----
-== Concurrency
+=== Concurrency
The FTP consumer (with the same endpoint) does not support concurrency
(the backing FTP client is not thread safe).
@@ -160,7 +162,7 @@ It is only a single endpoint that does not support
concurrent consumers.
The FTP producer does *not* have this issue, it supports concurrency.
[[FTP-DefaultWhenConsumingFiles]]
-== Default when consuming files
+=== Default when consuming files
The FTP consumer will by default leave the consumed
files untouched on the remote FTP server. You have to configure it
@@ -173,7 +175,7 @@ default move files to a `.camel` sub directory. The reason
Camel does
*not* do this by default for the FTP consumer is that it may lack
permissions by default to be able to move or delete files.
-=== limitations
+==== limitations
The option `readLock` can be used to force Camel *not* to consume files
that are currently in the progress of being written. However, this option
@@ -188,7 +190,7 @@ restricted to the FTP_ROOT folder. That prevents you from
moving files
outside the FTP area. If you want to move files to another area, you can
use soft links and move files into a soft linked folder.
-== Exchange Properties
+=== Exchange Properties
Camel sets the following exchange properties
@@ -203,7 +205,7 @@ Camel sets the following exchange properties
|`CamelBatchComplete` | `true` if there are no more files in this batch.
|=======================================================================
-== About timeouts
+=== About timeouts
The two sets of libraries (see top) have different API for setting
timeout. You can use the `connectTimeout` option for both of them to set
@@ -214,7 +216,7 @@ a timeout in millis to establish a network connection. An
individual
for FTP/FTPS as the data timeout, which corresponds to the
`ftpClient.dataTimeout` value. All timeout values are in millis.
-== Using Local Work Directory
+=== Using Local Work Directory
Camel supports consuming from remote FTP servers and downloading the
files directly into a local work directory. This avoids reading the
@@ -243,7 +245,7 @@ The `java.io.File` handle is then used as the Exchange
body. The file producer l
As Camel knows it's a local work file, it can optimize and use a rename
instead of a file copy, as the work file is meant to be deleted anyway.
====
-== Stepwise changing directories
+=== Stepwise changing directories
Camel FTP can operate in two modes in terms of
traversing directories when consuming files (e.g., downloading) or
@@ -418,7 +420,7 @@ invoked at all.
====
-== Filtering Strategies
+=== Filtering Strategies
Camel supports pluggable filtering strategies. They are described below.
@@ -427,7 +429,7 @@ Camel supports pluggable filtering strategies. They are
described below.
See also the documentation for filtering strategies on the
xref:file-component.adoc[File component].
====
-=== Custom filtering
+==== Custom filtering
Camel supports pluggable filtering strategies. This strategy it to use
the build in `org.apache.camel.component.file.GenericFileFilter` in
@@ -452,7 +454,7 @@ spring XML file:
</route>
----
-=== Filtering using ANT path matcher
+==== Filtering using ANT path matcher
The ANT path matcher is a filter shipped out-of-the-box in the
*camel-spring* jar. So you need to depend on *camel-spring* if you are
@@ -474,7 +476,7 @@ The sample below demonstrates how to use it:
from("ftp://admin@localhost:2222/public/camel?antInclude=**/*.txt";).to("...");
----
-== Using a proxy with SFTP
+=== Using a proxy with SFTP
To use an HTTP proxy to connect to your remote host, you can configure
your route in the following way:
@@ -497,7 +499,7 @@ You can also assign a username and password to the proxy,
if necessary.
Please consult the documentation for `com.jcraft.jsch.Proxy` to discover
all options.
-== Setting preferred SFTP authentication method
+=== Setting preferred SFTP authentication method
If you want to explicitly specify the list of authentication methods
that should be used by `sftp` component, use `preferredAuthentications`
@@ -512,7 +514,7 @@
from("sftp://localhost:9999/root?username=admin&password=admin&preferredAuthenti
to("bean:processFile");
----
-== Consuming a single file using a fixed name
+=== Consuming a single file using a fixed name
When you want to download a single file and knows the file name, you can
use `fileName=myFileName.txt` to tell Camel the name of the file to
@@ -547,7 +549,7 @@ single file (if it exists) and grab the file content as a
String type:
String data =
template.retrieveBodyNoWait("ftp://admin@localhost:21/nolist/?password=admin&stepwise=false&useList=false&ignoreFileNotFoundOrPermissionError=true&fileName=report.txt&delete=true";,
String.class);
----
-== Debug logging
+=== Debug logging
This component has log level *TRACE* that can be helpful if you have
problems.
diff --git a/components/camel-ftp/src/main/docs/sftp-component.adoc
b/components/camel-ftp/src/main/docs/sftp-component.adoc
index 87ee5149062..c43de32eeca 100644
--- a/components/camel-ftp/src/main/docs/sftp-component.adoc
+++ b/components/camel-ftp/src/main/docs/sftp-component.adoc
@@ -45,7 +45,9 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== Restoring Deprecated Key Types and Algorithms
+== Usage
+
+=== Restoring Deprecated Key Types and Algorithms
As of Camel 3.17.0, key types and algorithms that use SHA1 have been
deprecated. These can be restored, if necessary, by setting JSch configuration
directly. E.g.:
diff --git a/components/camel-git/src/main/docs/git-component.adoc
b/components/camel-git/src/main/docs/git-component.adoc
index 344de8ef5b7..9f3ded7f6bc 100644
--- a/components/camel-git/src/main/docs/git-component.adoc
+++ b/components/camel-git/src/main/docs/git-component.adoc
@@ -56,7 +56,9 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== Producer Example
+== Examples
+
+=== Producer Example
Below is an example route of a producer that adds a file test.java to a
local repository, commits it with a specific message on the `main` branch and
@@ -74,7 +76,7 @@ from("direct:start")
.to("git:///tmp/testRepo?operation=pushTag&tagName=myTag&remoteName=origin");
--------------------------------------------------------------------------------------------------------------------
-== Consumer Example
+=== Consumer Example
Below is an example route of a consumer that consumes commit:
@@ -84,7 +86,8 @@ from("git:///tmp/testRepo?type=commit")
.to(....)
---------------------------------------
-== Custom config file
+=== Custom config file
+
By default, camel-git will load ``.gitconfig`` file from user home folder.
You can override this by providing your own ``.gitconfig`` file.
diff --git a/components/camel-github/src/main/docs/github-component.adoc
b/components/camel-github/src/main/docs/github-component.adoc
index 7ec2076e150..0360f748e76 100644
--- a/components/camel-github/src/main/docs/github-component.adoc
+++ b/components/camel-github/src/main/docs/github-component.adoc
@@ -68,7 +68,9 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== Configuring authentication
+== Usage
+
+=== Configuring authentication
The GitHub component requires to be configured with an authentication token on
either the component or endpoint level.
@@ -80,7 +82,7 @@ GitHubComponent ghc = context.getComponent("github",
GitHubComponent.class);
ghc.setOauthToken("mytoken");
----
-== Consumer Endpoints:
+=== Consumer Endpoints:
[width="100%",cols="20%,20%,60%",options="header",]
|=======================================================================
@@ -97,7 +99,7 @@ request discussion) or
`org.eclipse.egit.github.core.CommitComment`
|commit |polling |`org.eclipse.egit.github.core.RepositoryCommit`
|=======================================================================
-== Producer Endpoints:
+=== Producer Endpoints:
[width="100%",cols="20%,20%,60%",options="header",]
|=======================================================================
diff --git
a/components/camel-google/camel-google-bigquery/src/main/docs/google-bigquery-component.adoc
b/components/camel-google/camel-google-bigquery/src/main/docs/google-bigquery-component.adoc
index 8c1f006f428..dee9d3bda74 100644
---
a/components/camel-google/camel-google-bigquery/src/main/docs/google-bigquery-component.adoc
+++
b/components/camel-google/camel-google-bigquery/src/main/docs/google-bigquery-component.adoc
@@ -93,7 +93,9 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== Producer Endpoints
+== Usage
+
+=== Producer Endpoints
Producer endpoints can accept and deliver to BigQuery individual and grouped
exchanges alike. Grouped exchanges have `Exchange.GROUPED_EXCHANGE` property
set.
@@ -105,7 +107,7 @@ correct suffix or partition decorator.
Google BigQuery endpoint expects the payload to be either a map or list of
maps. A payload containing a map
will insert a single row, and a payload containing a list of maps will insert
a row for each entry in the list.
-== Template tables
+=== Template tables
Reference:
https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables
@@ -121,7 +123,7 @@ from("direct:start")
------------------------------------------------------
Note it is recommended to use partitioning for this use case.
-== Partitioning
+=== Partitioning
Reference: https://cloud.google.com/bigquery/docs/creating-partitioned-tables
@@ -129,7 +131,7 @@ Partitioning is specified when creating a table and if set
data will be automati
separate tables. When inserting data a specific partition can be specified by
setting the
`GoogleBigQueryConstants.PARTITION_DECORATOR` header on the exchange.
-== Ensuring data consistency
+=== Ensuring data consistency
Reference:
https://cloud.google.com/bigquery/streaming-data-into-bigquery#dataconsistency
diff --git
a/components/camel-google/camel-google-pubsub-lite/src/main/docs/google-pubsub-lite-component.adoc
b/components/camel-google/camel-google-pubsub-lite/src/main/docs/google-pubsub-lite-component.adoc
index 3a56119a7d6..7ba0e8f9e14 100644
---
a/components/camel-google/camel-google-pubsub-lite/src/main/docs/google-pubsub-lite-component.adoc
+++
b/components/camel-google/camel-google-pubsub-lite/src/main/docs/google-pubsub-lite-component.adoc
@@ -66,7 +66,9 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== Producer Endpoints
+== Usage
+
+=== Producer Endpoints
Google PubSub Lite expects the payload to be `byte[]` array, Producer
endpoints will send:
@@ -80,13 +82,13 @@ When producing messages set the message header
`GooglePubsubConstants.ORDERING_K
This will be set as the PubSub Lite orderingKey for the message.
You can find more information on
https://cloud.google.com/pubsub/lite/docs/publishing#using_ordering_keys[Using
ordering keys].
-== Consumer Endpoints
+=== Consumer Endpoints
Google PubSub Lite will redeliver the message if it has not been acknowledged
within the time period set as a configuration option on the subscription.
The component will acknowledge the message once exchange processing has been
completed.
-== Message Body
+=== Message Body
The consumer endpoint returns the content of the message as `byte[]` - exactly
as the underlying system sends it.
It is up for the route to convert/unmarshall the contents.
diff --git
a/components/camel-google/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc
b/components/camel-google/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc
index a3d57eac01d..90dc45cd53a 100644
---
a/components/camel-google/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc
+++
b/components/camel-google/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc
@@ -60,7 +60,9 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== Producer Endpoints
+== Usage
+
+=== Producer Endpoints
Producer endpoints can accept and deliver to PubSub individual and grouped
exchanges alike. Grouped exchanges have `Exchange.GROUPED_EXCHANGE` property
set.
@@ -84,7 +86,7 @@ For more information, see
https://cloud.google.com/pubsub/docs/ordering[Ordering
Once exchange has been delivered to PubSub the PubSub Message ID will be
assigned to
the header `GooglePubsubConstants.MESSAGE_ID`.
-== Consumer Endpoints
+=== Consumer Endpoints
Google PubSub will redeliver the message if it has not been acknowledged
within the time period set
as a configuration option on the subscription.
@@ -97,18 +99,18 @@ To ack/nack the message the component uses Acknowledgement
ID stored as header `
If the header is removed or tampered with, the ack will fail and the message
will be redelivered
again after the ack deadline.
-== Message Body
+=== Message Body
The consumer endpoint returns the content of the message as `byte[]`. Exactly
as the underlying system sends it.
It is up for the route to convert/unmarshall the contents.
-== Authentication Configuration
+=== Authentication Configuration
By default, this component acquires credentials using
`GoogleCredentials.getApplicationDefault()`.
This behavior can be disabled by setting _authenticate_ option to `false`, in
which case requests to Google API will be made without authentication details.
This is only desirable when developing against an emulator.
This behavior can be altered by supplying a path to a service account key file.
-== Rollback and Redelivery
+=== Rollback and Redelivery
The rollback for Google PubSub relies on the idea of the Acknowledgement
Deadline - the time period where Google PubSub expects to receive the
acknowledgement.
If the acknowledgement has not been received, the message is redelivered.
@@ -126,7 +128,7 @@ setting the message header
`GooglePubsubConstants.ACK_DEADLINE` to the value in
include::spring-boot:partial$starter.adoc[]
-== Manual Acknowledgement
+=== Manual Acknowledgement
By default, the PubSub consumer will acknowledge messages once the exchange
has been processed, or negative-acknowledge them if the exchange has failed.
diff --git
a/components/camel-google/camel-google-storage/src/main/docs/google-storage-component.adoc
b/components/camel-google/camel-google-storage/src/main/docs/google-storage-component.adoc
index c4442465b2f..0da37c8e95f 100644
---
a/components/camel-google/camel-google-storage/src/main/docs/google-storage-component.adoc
+++
b/components/camel-google/camel-google-storage/src/main/docs/google-storage-component.adoc
@@ -229,12 +229,12 @@ from("direct:start")
This operation will return a download link url for the file OBJECT_NAME in the
bucket myCamelBucket. It's possible to specify the expiration time for the
created link through the header DOWNLOAD_LINK_EXPIRATION_TIME. If not
specified, by default it is 5 minutes.
-== Bucket Auto creation
+=== Bucket Auto creation
With the option `autoCreateBucket` users are able to avoid the autocreation of
a Bucket in case it doesn't exist. The default for this option is `true`.
If set to false, any operation on a not-existent bucket won't be successful
and an error will be returned.
-== MoveAfterRead consumer option
+=== MoveAfterRead consumer option
In addition to `deleteAfterRead` it has been added another option,
`moveAfterRead`.
With this option enabled the consumed object will be moved to a target
`destinationBucket` instead of being only deleted.
diff --git a/components/camel-grok/src/main/docs/grok-dataformat.adoc
b/components/camel-grok/src/main/docs/grok-dataformat.adoc
index 69ebc74750e..64c99f694b7 100644
--- a/components/camel-grok/src/main/docs/grok-dataformat.adoc
+++ b/components/camel-grok/src/main/docs/grok-dataformat.adoc
@@ -29,7 +29,7 @@ for this component:
</dependency>
------------------------------------------------------------
-== Basic usage
+== Usage
.Extract all IP addresses from input
[source,java]
@@ -48,12 +48,12 @@ from("file://apacheLogs")
.to("log:4xx")
--------------------------------------------------------------------------------
-== Preregistered patterns
+=== Preregistered patterns
This component comes with preregistered patterns, which are based on Logstash
patterns.
All
https://github.com/thekrakken/java-grok/tree/master/src/main/resources/patterns/patterns[Java
Grok Default Patterns] are preregistered and as such could be used without
manual registration.
-== Custom patterns
+=== Custom patterns
Camel Grok DataFormat supports plugable patterns, which are auto loaded from
Camel Registry.
You can register patterns with Java DSL and Spring DSL:
diff --git a/components/camel-groovy/src/main/docs/groovy-language.adoc
b/components/camel-groovy/src/main/docs/groovy-language.adoc
index 26bfbc82f7b..72515bdefa0 100644
--- a/components/camel-groovy/src/main/docs/groovy-language.adoc
+++ b/components/camel-groovy/src/main/docs/groovy-language.adoc
@@ -28,39 +28,9 @@ groovy("someGroovyExpression")
include::partial$language-options.adoc[]
// language options: END
-== Examples
-
-In the example below, we use a groovy script as predicate in the message
filter,
-to determine if any line items are over $100:
-
-[tabs]
-====
-
-Java::
-+
-[source,java]
-------------------------------------------------------------------------------------------------
-from("queue:foo")
- .filter(groovy("request.lineItems.any { i -> i.value > 100 }"))
- .to("queue:bar")
-------------------------------------------------------------------------------------------------
-
-XML DSL::
-+
-[source,xml]
-----
-<route>
- <from uri="queue:foo"/>
- <filter>
- <groovy>request.lineItems.any { i -> i.value > 100 }</groovy>
- <to uri="queue:bar"/>
- </filter>
-</route>
-----
-
-====
+== Usage
-== Groovy Context
+=== Groovy Context
Camel will provide exchange information in the Groovy context (just
a `Map`). The `Exchange` is transferred as:
@@ -87,7 +57,7 @@ a `Map`). The `Exchange` is transferred as:
|=======================================================================
-== How to get the result from multiple statements script
+=== How to get the result from multiple statements script
As the Groovy script engine evaluate method just return a `Null` if it runs a
multiple statements script. Camel now looks up the value of script result
@@ -103,7 +73,7 @@ bar = "baz";
result = body * 2 + 1
-------------------------------------------------------------
-== Customizing Groovy Shell
+=== Customizing Groovy Shell
For very special use-cases you may need to use a custom `GroovyShell` instance
in your
Groovy expressions. To provide the custom `GroovyShell`, add an implementation
@@ -128,7 +98,7 @@ public class CustomGroovyShellFactory implements
GroovyShellFactory {
Camel will then use your custom GroovyShell instance (containing your
custom static imports), instead of the default one.
-== Loading script from external resource
+=== Loading script from external resource
You can externalize the script and have Camel load it from a resource
such as `"classpath:"`, `"file:"`, or `"http:"`.
@@ -140,7 +110,7 @@ e.g., to refer to a file on the classpath you can do:
.setHeader("myHeader").groovy("resource:classpath:mygroovy.groovy")
-------------------------------------------------------------------
-== Dependencies
+=== Dependencies
To use scripting languages in your camel routes, you need to add a
dependency on *camel-groovy*.
@@ -158,5 +128,36 @@ the download page for the latest versions).
</dependency>
---------------------------------------
+== Examples
+
+In the example below, we use a groovy script as predicate in the message
filter,
+to determine if any line items are over $100:
+
+[tabs]
+====
+
+Java::
++
+[source,java]
+------------------------------------------------------------------------------------------------
+from("queue:foo")
+ .filter(groovy("request.lineItems.any { i -> i.value > 100 }"))
+ .to("queue:bar")
+------------------------------------------------------------------------------------------------
+
+XML DSL::
++
+[source,xml]
+----
+<route>
+ <from uri="queue:foo"/>
+ <filter>
+ <groovy>request.lineItems.any { i -> i.value > 100 }</groovy>
+ <to uri="queue:bar"/>
+ </filter>
+</route>
+----
+
+====
include::spring-boot:partial$starter.adoc[]
diff --git a/components/camel-grpc/src/main/docs/grpc-component.adoc
b/components/camel-grpc/src/main/docs/grpc-component.adoc
index 82f49904405..2aea45cdecc 100644
--- a/components/camel-grpc/src/main/docs/grpc-component.adoc
+++ b/components/camel-grpc/src/main/docs/grpc-component.adoc
@@ -54,7 +54,9 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== Transport security and authentication support
+== Usage
+
+=== Transport security and authentication support
The following https://grpc.io/docs/guides/auth.html[authentication] mechanisms
are built-in to gRPC and available in this component:
@@ -82,7 +84,7 @@ To enable these features, the following component properties
combinations must b
|||jwtSubject||Optional
|=======================================================================
-== gRPC producer resource type mapping
+=== gRPC producer resource type mapping
The table below shows the types of objects in the message body, depending on
the types (simple or stream) of incoming and outgoing parameters, as well as
the invocation style (synchronous or asynchronous). Please note that invocation
of the procedures with incoming stream parameter in asynchronous style is not
allowed.
@@ -102,11 +104,11 @@ The table below shows the types of objects in the message
body, depending on the
|=======================================================================
-== gRPC Proxy
+=== gRPC Proxy
It is not possible to create a universal proxy-route for all methods, so you
need to divide your gRPC service into several services by method's type: unary,
server streaming, client streaming and bidirectional streaming.
-=== Unary
+==== Unary
For unary requests, it is enough to write the following code:
diff --git
a/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc
b/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc
index 3ecc590b546..1ec5656d31f 100644
---
a/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc
+++
b/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc
@@ -106,7 +106,7 @@ eventBus.register(new Object(){
});
----------------------------------------------------------------------
-== DeadEvent considerations
+=== DeadEvent considerations
Keep in mind that due to the limitations caused by the design of the
Guava EventBus, you cannot specify event class to be received by the
@@ -155,7 +155,7 @@ follows.
from("guava-eventbus:busName?listenerInterface=com.example.CustomListener").to("seda:queue");
---------------------------------------------------------------------------------------------
-== Consuming multiple types of events
+=== Consuming multiple types of events
To define multiple types of events to be consumed by Guava
EventBus consumer use `listenerInterface` endpoint option, as listener
diff --git
a/components/camel-hashicorp-vault/src/main/docs/hashicorp-vault-component.adoc
b/components/camel-hashicorp-vault/src/main/docs/hashicorp-vault-component.adoc
index a4958d0d1d5..41d2019d6f5 100644
---
a/components/camel-hashicorp-vault/src/main/docs/hashicorp-vault-component.adoc
+++
b/components/camel-hashicorp-vault/src/main/docs/hashicorp-vault-component.adoc
@@ -43,6 +43,8 @@ include::partial$component-endpoint-options.adoc[]
// endpoint options: END
+== Examples
+
=== Using Hashicorp Vault Property Function
To use this function, you'll need to provide credentials for Hashicorp vault
as environment variables:
diff --git a/components/camel-headersmap/src/main/docs/headersmap.adoc
b/components/camel-headersmap/src/main/docs/headersmap.adoc
index 307ceee0a69..cde1782070c 100644
--- a/components/camel-headersmap/src/main/docs/headersmap.adoc
+++ b/components/camel-headersmap/src/main/docs/headersmap.adoc
@@ -12,7 +12,9 @@
The Headersmap component is a faster implementation of a case-insensitive map
which can be plugged in
and used by Camel at runtime to have slight faster performance in the Camel
Message headers.
-== Auto-detection from classpath
+== Usage
+
+=== Auto-detection from classpath
To use this implementation all you need to do is to add the `camel-headersmap`
dependency to the classpath,
and Camel should auto-detect this on startup and log as follows:
diff --git a/components/camel-hl7/src/main/docs/hl7terser-language.adoc
b/components/camel-hl7/src/main/docs/hl7terser-language.adoc
index c835d2456f6..32c96b0a35f 100644
--- a/components/camel-hl7/src/main/docs/hl7terser-language.adoc
+++ b/components/camel-hl7/src/main/docs/hl7terser-language.adoc
@@ -26,7 +26,7 @@ include::partial$language-options.adoc[]
// language options: END
-== Example
+== Examples
In the example below, we want to set a header with the patent id
from field QRD-8 in the QRY_A19 message:
@@ -46,7 +46,7 @@ from("direct:test2")
.to("mock:test2");
----
-== HL7 Validation
+=== HL7 Validation
Often it is preferable to first parse a HL7v2 message and in a separate
step validate it against a HAPI
@@ -109,7 +109,7 @@ from("direct:test1")
// route continues from here
----
-== HL7 Acknowledgement expression
+=== HL7 Acknowledgement expression
A common task in HL7v2 processing is to generate an acknowledgement
message as a response to an incoming HL7v2 message, e.g., based on a
