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 1a2dcb09ae72241e089a19f33e8b742b605ae652 Author: Otavio R. Piske <[email protected]> AuthorDate: Sun Feb 25 09:22:56 2024 +0100 CAMEL-20459: documentation fixes for the kamelet EIP. Signed-off-by: Otavio R. Piske <[email protected]> --- .../main/docs/modules/eips/pages/kamelet-eip.adoc | 23 +++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/kamelet-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/kamelet-eip.adoc index 7f3f10c3ecb..69abc78643b 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/kamelet-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/kamelet-eip.adoc @@ -7,18 +7,19 @@ :tabs-sync-option: Kamelets (Kamel route snippets) allow users to connect to external systems via a simplified interface, -hiding all the low level details about how those connections are implemented. +hiding all the low-level details about how those connections are implemented. [IMPORTANT] By default, calling kamelets should be done as xref:message-endpoint.adoc[endpoints] with the xref:components::kamelet-component.adoc[kamelet] component, such as `to("kamelet:mykamelet")`. -The Kamelet EIP allows calling Kamelets (i.e. xref:manual::route-template.adoc[Route Template]), +The Kamelet EIP allows calling Kamelets (i.e., xref:manual::route-template.adoc[Route Template]), **for special use-cases**. When a Kamelet is designed for a special use-case such as aggregating messages, and returning -a response message only when a group of aggregated message is completed. In other words the kamelet -does not return a response message for every incoming message. In special situations like these, +a response message only when a group of aggregated messages is completed. +In other words, kamelet does not return a response message for every incoming message. +In special situations like these, then you **must** use this Kamelet EIP instead of using the xref:components::kamelet-component.adoc[kamelet] component. Given the following Kamelet (as a route template): @@ -61,7 +62,7 @@ from("direct:start") .to("mock:result"); ---- -When calling a Kamelet you may just refer to the name (template id) of the Kamelet in the EIP as shown below: +When calling a Kamelet, you may refer to the name (template id) of the Kamelet in the EIP as shown below: == Options // eip options: START @@ -76,6 +77,12 @@ include::partial$eip-exchangeProperties.adoc[] == Using Kamelet EIP +[tabs] +==== + +Java:: ++ + [source,java] ---- from("direct:start") @@ -83,8 +90,8 @@ from("direct:start") .to("mock:result"); ---- -And in XML - +XML:: ++ [source,xml] ---- <route> @@ -94,6 +101,8 @@ And in XML </route> ---- +==== + Camel will then, when starting: * Lookup the xref:manual::route-template.adoc[Route Template] with the given id (in the example above its foo) from the `CamelContext`
