Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds ingest API request and response examples #2996

Merged
merged 6 commits into from
Dec 10, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 37 additions & 1 deletion docs/overlays/elasticsearch-shared-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Original file line number Diff line number Diff line change
@@ -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}"
Original file line number Diff line number Diff line change
@@ -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}"
11 changes: 11 additions & 0 deletions specification/ingest/put_pipeline/PutPipelineRequestExample2.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
summary: Creates an ingest pipeline.
szabosteve marked this conversation as resolved.
Show resolved Hide resolved
# 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}"
12 changes: 12 additions & 0 deletions specification/ingest/simulate/SimulatePipelineRequestExample1.yaml
Original file line number Diff line number Diff line change
@@ -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}"
Original file line number Diff line number Diff line change
@@ -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}"
Loading