Edit parameter descriptions for Ingest pipelines. (#841)

* Edit parameters descriptions for Ingest pipelines.


Signed-off-by: Archer <[email protected]>

Author: Naarcha-AWS

spec/namespaces/ingest.yaml

@@ -9,7 +9,7 @@ paths:
       operationId: ingest.get_pipeline.0
       x-operation-group: ingest.get_pipeline
       x-version-added: '1.0'
-      description: Returns a pipeline.
+      description: Returns an ingest pipeline.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/
       parameters:
@@ -23,7 +23,7 @@ paths:
       operationId: ingest.simulate.0
       x-operation-group: ingest.simulate
       x-version-added: '1.0'
-      description: Allows to simulate a pipeline with example documents.
+      description: Simulates an ingest pipeline with example documents.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/
       parameters:
@@ -37,7 +37,7 @@ paths:
       operationId: ingest.simulate.1
       x-operation-group: ingest.simulate
       x-version-added: '1.0'
-      description: Allows to simulate a pipeline with example documents.
+      description: Simulates an ingest pipeline with example documents.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/
       parameters:
@@ -52,7 +52,7 @@ paths:
       operationId: ingest.get_pipeline.1
       x-operation-group: ingest.get_pipeline
       x-version-added: '1.0'
-      description: Returns a pipeline.
+      description: Returns an ingest pipeline.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/
       parameters:
@@ -66,7 +66,7 @@ paths:
       operationId: ingest.put_pipeline.0
       x-operation-group: ingest.put_pipeline
       x-version-added: '1.0'
-      description: Creates or updates a pipeline.
+      description: Creates or updates an ingest pipeline.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/
       parameters:
@@ -83,7 +83,7 @@ paths:
       operationId: ingest.delete_pipeline.0
       x-operation-group: ingest.delete_pipeline
       x-version-added: '1.0'
-      description: Deletes a pipeline.
+      description: Deletes an ingest pipeline.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/ingest-apis/delete-ingest/
       parameters:
@@ -99,7 +99,7 @@ paths:
       operationId: ingest.simulate.2
       x-operation-group: ingest.simulate
       x-version-added: '1.0'
-      description: Allows to simulate a pipeline with example documents.
+      description: Simulates an ingest pipeline with example documents.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/
       parameters:
@@ -114,7 +114,7 @@ paths:
       operationId: ingest.simulate.3
       x-operation-group: ingest.simulate
       x-version-added: '1.0'
-      description: Allows to simulate a pipeline with example documents.
+      description: Simulates an ingest pipeline with example documents.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/
       parameters:
@@ -130,7 +130,7 @@ paths:
       operationId: ingest.processor_grok.0
       x-operation-group: ingest.processor_grok
       x-version-added: '1.0'
-      description: Returns a list of the built-in patterns.
+      description: Returns a list of built-in grok patterns.
       externalDocs:
         url: https://opensearch.org/docs/latest
       parameters:
@@ -149,21 +149,23 @@ components:
               _meta:
                 $ref: '../schemas/_common.yaml#/components/schemas/Metadata'
               description:
-                description: Description of the ingest pipeline.
+                description: The description for the ingest pipeline.
                 type: string
               on_failure:
-                description: Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, OpenSearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. OpenSearch will not attempt to run the pipeline's remaining processors.
+                description: |-
+                  The new processor to run immediately after another processor fails. The processors specified in the `on_failure` parameter run sequentially in the order specified. 
+                  If no pipeline are specified in `on_failure` array is specified, OpenSearch will not attempt to run the pipeline's remaining processors.
                 type: array
                 items:
                   $ref: '../schemas/ingest._common.yaml#/components/schemas/ProcessorContainer'
               processors:
-                description: Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.
+                description: The processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.
                 type: array
                 items:
                   $ref: '../schemas/ingest._common.yaml#/components/schemas/ProcessorContainer'
               version:
                 $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber'
-            description: The ingest definition
+            description: The ingest definition.
       required: true
     ingest.simulate:
       content:
@@ -172,7 +174,7 @@ components:
             type: object
             properties:
               docs:
-                description: Sample documents to test in the pipeline.
+                description: A list of sample documents to test in the pipeline.
                 type: array
                 items:
                   $ref: '../schemas/ingest.simulate.yaml#/components/schemas/Document'
@@ -227,7 +229,7 @@ components:
       in: path
       name: id
       description: |-
-        Pipeline ID or wildcard expression of pipeline IDs used to limit the request.
+        The pipeline ID or wildcard expression of pipeline IDs used to limit the request.
         To delete all ingest pipelines in a cluster, use a value of `*`.
       required: true
       schema:
@@ -236,7 +238,7 @@ components:
     ingest.delete_pipeline::query.cluster_manager_timeout:
       name: cluster_manager_timeout
       in: query
-      description: Operation timeout for connection to cluster-manager node.
+      description: The amount of time allowed to establish a connection to the cluster manager node.
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Duration'
       x-version-added: '2.0'
@@ -255,17 +257,15 @@ components:
     ingest.delete_pipeline::query.timeout:
       in: query
       name: timeout
-      description: |-
-        Period to wait for a response.
-        If no response is received before the timeout expires, the request fails and returns an error.
+      description: The amount of time to wait for a response.
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Duration'
       style: form
     ingest.get_pipeline::path.id:
       in: path
       name: id
       description: |-
-        Comma-separated list of pipeline IDs to retrieve.
+        A comma-separated list of pipeline IDs to retrieve.
         Wildcard (`*`) expressions are supported.
         To get all ingest pipelines, omit this parameter or use `*`.
       required: true
@@ -275,7 +275,7 @@ components:
     ingest.get_pipeline::query.cluster_manager_timeout:
       name: cluster_manager_timeout
       in: query
-      description: Operation timeout for connection to cluster-manager node.
+      description: The amount of time allowed to establish a connection to the cluster manager node.
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Duration'
       x-version-added: '2.0'
@@ -294,15 +294,15 @@ components:
     ingest.put_pipeline::path.id:
       in: path
       name: id
-      description: ID of the ingest pipeline to create or update.
+      description: The ID of the ingest pipeline.
       required: true
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Id'
       style: simple
     ingest.put_pipeline::query.cluster_manager_timeout:
       name: cluster_manager_timeout
       in: query
-      description: Operation timeout for connection to cluster-manager node.
+      description: The amount of time allowed to establish a connection to the cluster manager node.
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Duration'
       x-version-added: '2.0'
@@ -319,15 +319,15 @@ components:
     ingest.put_pipeline::query.timeout:
       in: query
       name: timeout
-      description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
+      description: The amount of time to wait for a response.
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Duration'
       style: form
     ingest.simulate::path.id:
       in: path
       name: id
       description: |-
-        Pipeline to test.
+        The pipeline to test.
         If you don't specify a `pipeline` in the request body, this parameter is required.
       required: true
       schema:
@@ -336,15 +336,15 @@ components:
     ingest.simulate::query.verbose:
       in: query
       name: verbose
-      description: If `true`, the response includes output data for each processor in the executed pipeline.
+      description: When `true`, the response includes output data for each processor in the pipeline
       schema:
         type: boolean
         default: false
       style: form
     ingest.processor_grok::query.s:
       name: s
       in: query
-      description: Sort returned patterns by key name.
+      description: Determines how to sort returned grok patterns by key name.
       schema:
         type: boolean
         default: false