You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by or...@apache.org on 2024/02/17 13:21:03 UTC
(camel) 01/09: CAMEL-20410: documentation fixes for camel-consul
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
commit cb38e14c45029a3afdfdeb1f1a944af09e70c463
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sat Feb 17 13:11:07 2024 +0100
CAMEL-20410: documentation fixes for camel-consul
- Fixed samples
- Converted to use tabs
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
components/camel-consul/src/main/docs/consul-component.adoc | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/components/camel-consul/src/main/docs/consul-component.adoc b/components/camel-consul/src/main/docs/consul-component.adoc
index 8045cd5a683..15f8c17ca97 100644
--- a/components/camel-consul/src/main/docs/consul-component.adoc
+++ b/components/camel-consul/src/main/docs/consul-component.adoc
@@ -19,7 +19,7 @@ The Consul component is a component for integrating your application with https:
Maven users will need to add the following dependency to their pom.xml
for this component:
-[source,java]
+[source,xml]
-------------------------------------------------
<dependency>
<groupId>org.apache.camel</groupId>
@@ -73,14 +73,17 @@ The `apiEndpoint` denotes the type of https://www.consul.io/api-docs[consul api]
As an example, we will show how to use the `ConsulAgentProducer` to register a service by means of the Consul agent api.
-Registering and deregistering are examples for possible actions against the Consul agent api.
+Registering and unregistering are examples for possible actions against the Consul agent api.
The desired action can be defined by setting the header `ConsulConstants.CONSUL_ACTION` to a value from the `ConsulXXXActions` interface of the respective Consul api. E.g. `ConsulAgentActions` contains the actions for the agent api.
If you set `CONSUL_ACTION` to `ConsulAgentActions.REGISTER`, the agent action `REGISTER` will be executed.
-TIP: Which producer action invokes which consul api is defined by the respective producer.
-E.g. the `ConsulAgentProducer` maps `ConsulAgentActions.REGISTER` to an invocation of `AgentClient.register`.
+[TIP]
+====
+Which producer action invoked by which consul api is defined by the respective producer.
+E.g., the `ConsulAgentProducer` maps `ConsulAgentActions.REGISTER` to an invocation of `AgentClient.register`.
+====
[source,java]
----