From b5d7042ae1c3ac809579303968d1088d7eb969c5 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS Date: Fri, 4 Feb 2022 11:44:49 -0600 Subject: [PATCH] Address Liz's feedback. Fix typos Signed-off-by: Naarcha-AWS --- .../rest-api/ingest-apis/create-update-ingest.md | 2 +- _opensearch/rest-api/ingest-apis/delete-ingest.md | 4 ++-- _opensearch/rest-api/ingest-apis/get-ingest.md | 2 +- _opensearch/rest-api/ingest-apis/index.md | 2 +- _opensearch/rest-api/ingest-apis/simulate-ingest.md | 10 +++++----- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/_opensearch/rest-api/ingest-apis/create-update-ingest.md b/_opensearch/rest-api/ingest-apis/create-update-ingest.md index de80f689..d989bbc3 100644 --- a/_opensearch/rest-api/ingest-apis/create-update-ingest.md +++ b/_opensearch/rest-api/ingest-apis/create-update-ingest.md @@ -36,7 +36,7 @@ PUT _ingest/pipeline/{id} Field | Type | Description :--- | :--- | :--- -`description` (optional) | string | Description of your ingest pipeline +`description` (optional) | string | Description of your ingest pipeline. `processors` | processor objects | A processor that transforms documents. Runs in the order specified. Appears in index once ran. ```json diff --git a/_opensearch/rest-api/ingest-apis/delete-ingest.md b/_opensearch/rest-api/ingest-apis/delete-ingest.md index 33002ccd..6f8ba21d 100644 --- a/_opensearch/rest-api/ingest-apis/delete-ingest.md +++ b/_opensearch/rest-api/ingest-apis/delete-ingest.md @@ -21,8 +21,8 @@ DELETE _ingest/pipeline/{id} Parameter | Type | Description :--- | :--- | :--- -master_timeout | time | Explicit operation timeout for connection to master node -timeout | time | Explicit operation timeout +master_timeout | time | How long to wait for a connection to the master node. +timeout | time | How long to wait for the request to return. ## Response diff --git a/_opensearch/rest-api/ingest-apis/get-ingest.md b/_opensearch/rest-api/ingest-apis/get-ingest.md index 5b041642..1cca1625 100644 --- a/_opensearch/rest-api/ingest-apis/get-ingest.md +++ b/_opensearch/rest-api/ingest-apis/get-ingest.md @@ -37,7 +37,7 @@ All parameters are optional. Parameter | Type | Description :--- | :--- | :--- -master_timeout | time | Explicit operation timeout for connection to master node +master_timeout | time | How long to wait for a connection to the master node. ## Response diff --git a/_opensearch/rest-api/ingest-apis/index.md b/_opensearch/rest-api/ingest-apis/index.md index 7447327c..6bfe7529 100644 --- a/_opensearch/rest-api/ingest-apis/index.md +++ b/_opensearch/rest-api/ingest-apis/index.md @@ -10,6 +10,6 @@ redirect_from: # Ingest APIs -Before you index your data, OpenSearch's ingest APIs help transform your data through the creation of ingest pipelines. Pipelines are made up of processors, a customizable task that run in succession. The transformed data appears in your data stream or index after each of the processors completes. +Before you index your data, OpenSearch's ingest APIs help transform your data through the creation of ingest pipelines. Pipelines are made up of processors, a customizable task that run in the order they appear in the request body. The transformed data appears in your data stream or index after each of the processors completes. Ingest pipelines in OpenSearch are managed using ingest API operations. In production environments, your cluster should contain at least one node with the `node.roles: [ingest]`. For more information on setting up node roles within a cluster, see [Cluster Formation]({{site.url}}{{site.baseurl}}/cluster/). diff --git a/_opensearch/rest-api/ingest-apis/simulate-ingest.md b/_opensearch/rest-api/ingest-apis/simulate-ingest.md index 8957d8cd..8705c5fd 100644 --- a/_opensearch/rest-api/ingest-apis/simulate-ingest.md +++ b/_opensearch/rest-api/ingest-apis/simulate-ingest.md @@ -8,7 +8,7 @@ nav_order: 13 # Simulate a pipeline -Simulates an ingest pipeline with any example documents set you specify. +Simulates an ingest pipeline with any example documents you specify. ## Example @@ -54,7 +54,7 @@ POST _ingest/pipeline/{id}/_simulate Parameter | Type | Description :--- | :--- | :--- -verbose | boolean | Verbose mode. Display data output for each processor in executed pipeline +verbose | boolean | Verbose mode. Display data output for each processor in executed pipeline. ## Request body fields @@ -67,9 +67,9 @@ The `docs` field can include the following subfields: Field | Type | Description :--- | :--- | :--- -`id` (Optional) | string | An optional identifier for the document. Cannot be used elsewhere in the index -`index` (Optional) | string |The index where the documents transformed data will be stored -`source` | object | The documents JSON body +`id` (Optional) | string | An optional identifier for the document. The identifier cannot be used elsewhere in the index. +`index` (Optional) | string | The index where the document's transformed data will be stored. +`source` | object | The document's JSON body. ## Response