Adds ingest API request and response examples (#2996)

Co-authored-by: Lisa Cawley <[email protected]>
(cherry picked from commit 2045505)

Author: 2 people

docs/overlays/elasticsearch-shared-overlays.yaml

@@ -1257,4 +1257,40 @@ actions:
             application/json:
               examples:
                 indicesExplainDataLifecycleResponseExample:
-                  $ref: "../../specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleResponseExample1.yaml"
+                  $ref: "../../specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleResponseExample1.yaml"
+  - target: "$.components['responses']['ingest.get_pipeline#200']"
+    description: "Add example for get pipeline response"
+    update: 
+      content:
+        application/json:
+          examples:
+            indicesGetDataStreamResponseExample:
+              $ref: "../../specification/ingest/get_pipeline/GetPipelineResponseExample1.yaml"
+  - target: "$.paths['/_ingest/pipeline/{id}']['put']"
+    description: "Add examples for create pipeline"
+    update: 
+      requestBody: 
+        content: 
+          application/json: 
+            examples: 
+              putPipelineRequestExample1: 
+                $ref: "../../specification/ingest/put_pipeline/PutPipelineRequestExample1.yaml"
+              putPipelineRequestExample2: 
+                $ref: "../../specification/ingest/put_pipeline/PutPipelineRequestExample2.yaml"
+  - target: "$.components['requestBodies']['ingest.simulate']"
+    description: "Add example for simulate pipeline request"
+    update: 
+      content:
+        application/json:
+          examples:
+            simulatePipelineRequestExample1:
+              $ref: "../../specification/ingest/simulate/SimulatePipelineRequestExample1.yaml"
+  - target: "$.components['responses']['ingest.simulate#200']"
+    description: "Add example for simulate pipeline response"
+    update: 
+      content:
+        application/json:
+          examples:
+            simulatePipelineResponseExample1:
+              $ref: "../../specification/ingest/simulate/SimulatePipelineResponseExample1.yaml"
+  

specification/ingest/get_pipeline/GetPipelineResponseExample1.yaml

@@ -0,0 +1,9 @@
+summary: A successful response for retrieving information about an ingest pipeline.
+# description: ''
+# type: response
+# response_code: 200
+value:
+  "{\n  \"my-pipeline-id\" : {\n    \"description\" : \"describe pipeline\",\n\
+  \    \"version\" : 123,\n    \"processors\" : [\n      {\n        \"set\" : {\n\
+  \          \"field\" : \"foo\",\n          \"value\" : \"bar\"\n        }\n    \
+  \  }\n    ]\n  }\n}"

specification/ingest/put_pipeline/PutPipelineRequestExample1.yaml

@@ -0,0 +1,9 @@
+summary: Create an ingest pipeline.
+# method_request: PUT _ingest/pipeline/my-pipeline-id
+# description: ''
+# type: request
+value:
+  "{\n  \"description\" : \"My optional pipeline description\",\n  \"processors\"\
+  \ : [\n    {\n      \"set\" : {\n        \"description\" : \"My optional processor\
+  \ description\",\n        \"field\": \"my-keyword-field\",\n        \"value\": \"\
+  foo\"\n      }\n    }\n  ]\n}"

specification/ingest/put_pipeline/PutPipelineRequestExample2.yaml

@@ -0,0 +1,11 @@
+summary: Create an ingest pipeline with metadata.
+# method_request: PUT /_ingest/pipeline/my-pipeline-id
+description: You can use the `_meta` parameter to add arbitrary metadata to a pipeline.
+type: request
+value:
+  "{\n  \"description\" : \"My optional pipeline description\",\n  \"processors\"\
+  \ : [\n    {\n      \"set\" : {\n        \"description\" : \"My optional processor\
+  \ description\",\n        \"field\": \"my-keyword-field\",\n        \"value\": \"\
+  foo\"\n      }\n    }\n  ],\n  \"_meta\": {\n    \"reason\": \"set my-keyword-field\
+  \ to foo\",\n    \"serialization\": {\n      \"class\": \"MyPipeline\",\n      \"\
+  id\": 10\n    }\n  }\n}"

specification/ingest/simulate/SimulatePipelineRequestExample1.yaml

@@ -0,0 +1,12 @@
+summary: Run an ingest pipeline against a set of provided documents.
+# method_request: POST /_ingest/pipeline/_simulate
+description: You can specify the used pipeline either in the request body or as a path parameter.
+# type: request
+value:
+  "{\n  \"pipeline\" :\n  {\n    \"description\": \"_description\",\n    \"processors\"\
+  : [\n      {\n        \"set\" : {\n          \"field\" : \"field2\",\n         \
+  \ \"value\" : \"_value\"\n        }\n      }\n    ]\n  },\n  \"docs\": [\n    {\n\
+  \      \"_index\": \"index\",\n      \"_id\": \"id\",\n      \"_source\": {\n  \
+  \      \"foo\": \"bar\"\n      }\n    },\n    {\n      \"_index\": \"index\",\n\
+  \      \"_id\": \"id\",\n      \"_source\": {\n        \"foo\": \"rab\"\n      }\n\
+  \    }\n  ]\n}"

specification/ingest/simulate/SimulatePipelineResponseExample1.yaml

@@ -0,0 +1,15 @@
+summary: A successful response for running an ingest pipeline against a set of provided documents.
+# description: ''
+# type: response
+# response_code: 200
+value:
+  "{\n   \"docs\": [\n      {\n         \"doc\": {\n            \"_id\": \"id\"\
+  ,\n            \"_index\": \"index\",\n            \"_version\": \"-3\",\n     \
+  \       \"_source\": {\n               \"field2\": \"_value\",\n               \"\
+  foo\": \"bar\"\n            },\n            \"_ingest\": {\n               \"timestamp\"\
+  : \"2017-05-04T22:30:03.187Z\"\n            }\n         }\n      },\n      {\n \
+  \        \"doc\": {\n            \"_id\": \"id\",\n            \"_index\": \"index\"\
+  ,\n            \"_version\": \"-3\",\n            \"_source\": {\n             \
+  \  \"field2\": \"_value\",\n               \"foo\": \"rab\"\n            },\n  \
+  \          \"_ingest\": {\n               \"timestamp\": \"2017-05-04T22:30:03.188Z\"\
+  \n            }\n         }\n      }\n   ]\n}"