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 0aee6168e60879f53b98f8bf59fffb43c6443e6d Author: Otavio Rodolfo Piske <[email protected]> AuthorDate: Wed Feb 21 15:05:48 2024 +0100 CAMEL-20410: documentation fixes for camel-opensearch - Fixed samples - Fixed grammar and typos - Fixed punctuation - Added and/or fixed links - Converted to use tabs --- .../src/main/docs/opensearch-component.adoc | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/components/camel-opensearch/src/main/docs/opensearch-component.adoc b/components/camel-opensearch/src/main/docs/opensearch-component.adoc index 8a8272bdb0b..1517bd5a09e 100644 --- a/components/camel-opensearch/src/main/docs/opensearch-component.adoc +++ b/components/camel-opensearch/src/main/docs/opensearch-component.adoc @@ -56,8 +56,8 @@ include::partial$component-endpoint-headers.adoc[] == Message Operations -The following https://opensearch.org/ operations are currently supported. Simply -set an endpoint URI option or exchange header with a key of "operation" +The following https://opensearch.org/ operations are currently supported. +Set an endpoint URI option or exchange header with a key of "operation" and a value set to one of the following. Some operations also require other parameters or the message body to be set. @@ -109,7 +109,7 @@ the key "indexId". |=== == Configure the component and enable basic authentication -To use the OpenSearch component it has to be configured with a minimum configuration. +To use the OpenSearch component, it has to be configured with a minimum configuration. [source,java] ---- @@ -149,7 +149,7 @@ from("direct:index") </route> ---- -*For this operation you'll need to specify a indexId header.* +*For this operation, you'll need to specify an indexId header.* A client would simply need to pass a body message containing a Map to the route. The result body contains the indexId created. @@ -203,7 +203,7 @@ HitsMetadata<?> response = template.requestBody("direct:search", query, HitsMeta ---- -Search using OpenSearch scroll api in order to fetch all results. +Search using OpenSearch scroll api to fetch all results. [source,java] ---- @@ -242,7 +242,7 @@ from("direct:search") == MultiSearch Example -MultiSearching on specific field(s) and value use the Operation ´MultiSearch´. +MultiSearching on specific field(s) and value uses the Operation `MultiSearch`. Pass in the MultiSearchRequest instance [source,java] @@ -273,6 +273,6 @@ List<MultiSearchResponseItem<?>> response = template.requestBody("direct:multiSe == Document type -For all the search operations, it is possible to indicate the type of document to retrieve in order to get the result already unmarshalled with the expected type. +For all the search operations, it is possible to indicate the type of document to retrieve to get the result already unmarshalled with the expected type. The document type can be set using the header "documentClass" or via the uri parameter of the same name.
