From f47a998ef973857297d1042fddf347edc4fe8697 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 9 Aug 2024 14:25:20 +0200 Subject: [PATCH 1/4] Adds async search API request and response examples. --- .../async_search/get/AsyncSearchGetResponseExample1.json | 7 +++++++ .../async_search/get/AsyncSearchGetResponseExample2.json | 7 +++++++ .../async_search/get/AsyncSearchGetResponseExample3.json | 7 +++++++ .../status/AsyncSearchStatusResponseExample1.json | 7 +++++++ .../submit/AsyncSearchSubmitRequestExample1.json | 7 +++++++ .../submit/AsyncSearchSubmitResponseExample1.json | 7 +++++++ 6 files changed, 42 insertions(+) create mode 100644 specification/async_search/get/AsyncSearchGetResponseExample1.json create mode 100644 specification/async_search/get/AsyncSearchGetResponseExample2.json create mode 100644 specification/async_search/get/AsyncSearchGetResponseExample3.json create mode 100644 specification/async_search/status/AsyncSearchStatusResponseExample1.json create mode 100644 specification/async_search/submit/AsyncSearchSubmitRequestExample1.json create mode 100644 specification/async_search/submit/AsyncSearchSubmitResponseExample1.json diff --git a/specification/async_search/get/AsyncSearchGetResponseExample1.json b/specification/async_search/get/AsyncSearchGetResponseExample1.json new file mode 100644 index 0000000000..a5b921bf09 --- /dev/null +++ b/specification/async_search/get/AsyncSearchGetResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A succesful response when retrieving the results of a previously submitted async search request given its identifier.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_partial\" : false, <1>\n \"is_running\" : false, <2>\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986, <3>\n \"completion_time_in_millis\" : 1583945903130, <4>\n \"response\" : {\n \"took\" : 12144,\n \"timed_out\" : false,\n \"num_reduce_phases\" : 46, <5>\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 188, <6>\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"hits\" : {\n \"total\" : {\n \"value\" : 456433,\n \"relation\" : \"eq\"\n },\n \"max_score\" : null,\n \"hits\" : [ ]\n },\n \"aggregations\" : { <7>\n \"sale_date\" : {\n \"buckets\" : []\n }\n }\n }\n}" +} \ No newline at end of file diff --git a/specification/async_search/get/AsyncSearchGetResponseExample2.json b/specification/async_search/get/AsyncSearchGetResponseExample2.json new file mode 100644 index 0000000000..ed849a6673 --- /dev/null +++ b/specification/async_search/get/AsyncSearchGetResponseExample2.json @@ -0,0 +1,7 @@ +{ + "summary": "A succesful response when retrieving the status of a previously submitted and completed async search without the results.", + "description": "For an async search that has been completed, the status response has an additional `completion_status` field that shows the status code of the completed async search which was – in this case – a success.", + "type": "response", + "response_code": 200, + "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : false,\n \"is_partial\" : false,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 562,\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"completion_status\" : 200 <1>\n}" +} \ No newline at end of file diff --git a/specification/async_search/get/AsyncSearchGetResponseExample3.json b/specification/async_search/get/AsyncSearchGetResponseExample3.json new file mode 100644 index 0000000000..834929b908 --- /dev/null +++ b/specification/async_search/get/AsyncSearchGetResponseExample3.json @@ -0,0 +1,7 @@ +{ + "summary": "A succesful response when retrieving the status of a previously submitted and completed async search without the results.", + "description": "For an async search that has been completed, the status response has an additional `completion_status` field that shows the status code of the completed async search which was completed – in this case – with an error.", + "type": "response", + "response_code": 200, + "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : false,\n \"is_partial\" : true,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 450,\n \"skipped\" : 0,\n \"failed\" : 112\n },\n \"completion_status\" : 503 <1>\n}" +} \ No newline at end of file diff --git a/specification/async_search/status/AsyncSearchStatusResponseExample1.json b/specification/async_search/status/AsyncSearchStatusResponseExample1.json new file mode 100644 index 0000000000..5f77ab0d4f --- /dev/null +++ b/specification/async_search/status/AsyncSearchStatusResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A succesful response when retrieving the status of a previously submitted async search without the results.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : true,\n \"is_partial\" : true,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 188, <1>\n \"skipped\" : 0,\n \"failed\" : 0\n }\n}" +} \ No newline at end of file diff --git a/specification/async_search/submit/AsyncSearchSubmitRequestExample1.json b/specification/async_search/submit/AsyncSearchSubmitRequestExample1.json new file mode 100644 index 0000000000..d61bfe29d2 --- /dev/null +++ b/specification/async_search/submit/AsyncSearchSubmitRequestExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "Performs a search request asynchronously.", + "method_request": "POST /sales*/_async_search?size=0", + "description": "Accepts the same parameters and request body as the search API.", + "type": "request", + "value": "{\n \"sort\": [\n { \"date\": { \"order\": \"asc\" } }\n ],\n \"aggs\": {\n \"sale_date\": {\n \"date_histogram\": {\n \"field\": \"date\",\n \"calendar_interval\": \"1d\"\n }\n }\n }\n}" +} \ No newline at end of file diff --git a/specification/async_search/submit/AsyncSearchSubmitResponseExample1.json b/specification/async_search/submit/AsyncSearchSubmitResponseExample1.json new file mode 100644 index 0000000000..2580f4f710 --- /dev/null +++ b/specification/async_search/submit/AsyncSearchSubmitResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response when performing search asynchronously.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\", <1>\n \"is_partial\" : true, <2>\n \"is_running\" : true, <3>\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"response\" : {\n \"took\" : 1122,\n \"timed_out\" : false,\n \"num_reduce_phases\" : 0,\n \"_shards\" : {\n \"total\" : 562, <4>\n \"successful\" : 3, <5>\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"hits\" : {\n \"total\" : {\n \"value\" : 157483, <6>\n \"relation\" : \"gte\"\n },\n \"max_score\" : null,\n \"hits\" : [ ]\n }\n }\n}" +} \ No newline at end of file From 3365a0fa2ca09a41afc5ad8370817b87bed505ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 9 Aug 2024 14:26:16 +0200 Subject: [PATCH 2/4] Format fix. --- .../get/AsyncSearchGetResponseExample1.json | 12 ++++++------ .../get/AsyncSearchGetResponseExample2.json | 12 ++++++------ .../get/AsyncSearchGetResponseExample3.json | 12 ++++++------ .../status/AsyncSearchStatusResponseExample1.json | 12 ++++++------ .../submit/AsyncSearchSubmitRequestExample1.json | 12 ++++++------ .../submit/AsyncSearchSubmitResponseExample1.json | 12 ++++++------ 6 files changed, 36 insertions(+), 36 deletions(-) diff --git a/specification/async_search/get/AsyncSearchGetResponseExample1.json b/specification/async_search/get/AsyncSearchGetResponseExample1.json index a5b921bf09..7844cfa304 100644 --- a/specification/async_search/get/AsyncSearchGetResponseExample1.json +++ b/specification/async_search/get/AsyncSearchGetResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A succesful response when retrieving the results of a previously submitted async search request given its identifier.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_partial\" : false, <1>\n \"is_running\" : false, <2>\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986, <3>\n \"completion_time_in_millis\" : 1583945903130, <4>\n \"response\" : {\n \"took\" : 12144,\n \"timed_out\" : false,\n \"num_reduce_phases\" : 46, <5>\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 188, <6>\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"hits\" : {\n \"total\" : {\n \"value\" : 456433,\n \"relation\" : \"eq\"\n },\n \"max_score\" : null,\n \"hits\" : [ ]\n },\n \"aggregations\" : { <7>\n \"sale_date\" : {\n \"buckets\" : []\n }\n }\n }\n}" -} \ No newline at end of file + "summary": "A succesful response when retrieving the results of a previously submitted async search request given its identifier.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_partial\" : false, <1>\n \"is_running\" : false, <2>\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986, <3>\n \"completion_time_in_millis\" : 1583945903130, <4>\n \"response\" : {\n \"took\" : 12144,\n \"timed_out\" : false,\n \"num_reduce_phases\" : 46, <5>\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 188, <6>\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"hits\" : {\n \"total\" : {\n \"value\" : 456433,\n \"relation\" : \"eq\"\n },\n \"max_score\" : null,\n \"hits\" : [ ]\n },\n \"aggregations\" : { <7>\n \"sale_date\" : {\n \"buckets\" : []\n }\n }\n }\n}" +} diff --git a/specification/async_search/get/AsyncSearchGetResponseExample2.json b/specification/async_search/get/AsyncSearchGetResponseExample2.json index ed849a6673..0ba475a36e 100644 --- a/specification/async_search/get/AsyncSearchGetResponseExample2.json +++ b/specification/async_search/get/AsyncSearchGetResponseExample2.json @@ -1,7 +1,7 @@ { - "summary": "A succesful response when retrieving the status of a previously submitted and completed async search without the results.", - "description": "For an async search that has been completed, the status response has an additional `completion_status` field that shows the status code of the completed async search which was – in this case – a success.", - "type": "response", - "response_code": 200, - "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : false,\n \"is_partial\" : false,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 562,\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"completion_status\" : 200 <1>\n}" -} \ No newline at end of file + "summary": "A succesful response when retrieving the status of a previously submitted and completed async search without the results.", + "description": "For an async search that has been completed, the status response has an additional `completion_status` field that shows the status code of the completed async search which was – in this case – a success.", + "type": "response", + "response_code": 200, + "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : false,\n \"is_partial\" : false,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 562,\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"completion_status\" : 200 <1>\n}" +} diff --git a/specification/async_search/get/AsyncSearchGetResponseExample3.json b/specification/async_search/get/AsyncSearchGetResponseExample3.json index 834929b908..05c6df49b1 100644 --- a/specification/async_search/get/AsyncSearchGetResponseExample3.json +++ b/specification/async_search/get/AsyncSearchGetResponseExample3.json @@ -1,7 +1,7 @@ { - "summary": "A succesful response when retrieving the status of a previously submitted and completed async search without the results.", - "description": "For an async search that has been completed, the status response has an additional `completion_status` field that shows the status code of the completed async search which was completed – in this case – with an error.", - "type": "response", - "response_code": 200, - "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : false,\n \"is_partial\" : true,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 450,\n \"skipped\" : 0,\n \"failed\" : 112\n },\n \"completion_status\" : 503 <1>\n}" -} \ No newline at end of file + "summary": "A succesful response when retrieving the status of a previously submitted and completed async search without the results.", + "description": "For an async search that has been completed, the status response has an additional `completion_status` field that shows the status code of the completed async search which was completed – in this case – with an error.", + "type": "response", + "response_code": 200, + "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : false,\n \"is_partial\" : true,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 450,\n \"skipped\" : 0,\n \"failed\" : 112\n },\n \"completion_status\" : 503 <1>\n}" +} diff --git a/specification/async_search/status/AsyncSearchStatusResponseExample1.json b/specification/async_search/status/AsyncSearchStatusResponseExample1.json index 5f77ab0d4f..d883c4a443 100644 --- a/specification/async_search/status/AsyncSearchStatusResponseExample1.json +++ b/specification/async_search/status/AsyncSearchStatusResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A succesful response when retrieving the status of a previously submitted async search without the results.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : true,\n \"is_partial\" : true,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 188, <1>\n \"skipped\" : 0,\n \"failed\" : 0\n }\n}" -} \ No newline at end of file + "summary": "A succesful response when retrieving the status of a previously submitted async search without the results.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : true,\n \"is_partial\" : true,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 188, <1>\n \"skipped\" : 0,\n \"failed\" : 0\n }\n}" +} diff --git a/specification/async_search/submit/AsyncSearchSubmitRequestExample1.json b/specification/async_search/submit/AsyncSearchSubmitRequestExample1.json index d61bfe29d2..56f3aa1345 100644 --- a/specification/async_search/submit/AsyncSearchSubmitRequestExample1.json +++ b/specification/async_search/submit/AsyncSearchSubmitRequestExample1.json @@ -1,7 +1,7 @@ { - "summary": "Performs a search request asynchronously.", - "method_request": "POST /sales*/_async_search?size=0", - "description": "Accepts the same parameters and request body as the search API.", - "type": "request", - "value": "{\n \"sort\": [\n { \"date\": { \"order\": \"asc\" } }\n ],\n \"aggs\": {\n \"sale_date\": {\n \"date_histogram\": {\n \"field\": \"date\",\n \"calendar_interval\": \"1d\"\n }\n }\n }\n}" -} \ No newline at end of file + "summary": "Performs a search request asynchronously.", + "method_request": "POST /sales*/_async_search?size=0", + "description": "Accepts the same parameters and request body as the search API.", + "type": "request", + "value": "{\n \"sort\": [\n { \"date\": { \"order\": \"asc\" } }\n ],\n \"aggs\": {\n \"sale_date\": {\n \"date_histogram\": {\n \"field\": \"date\",\n \"calendar_interval\": \"1d\"\n }\n }\n }\n}" +} diff --git a/specification/async_search/submit/AsyncSearchSubmitResponseExample1.json b/specification/async_search/submit/AsyncSearchSubmitResponseExample1.json index 2580f4f710..37028ba9e2 100644 --- a/specification/async_search/submit/AsyncSearchSubmitResponseExample1.json +++ b/specification/async_search/submit/AsyncSearchSubmitResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A successful response when performing search asynchronously.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\", <1>\n \"is_partial\" : true, <2>\n \"is_running\" : true, <3>\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"response\" : {\n \"took\" : 1122,\n \"timed_out\" : false,\n \"num_reduce_phases\" : 0,\n \"_shards\" : {\n \"total\" : 562, <4>\n \"successful\" : 3, <5>\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"hits\" : {\n \"total\" : {\n \"value\" : 157483, <6>\n \"relation\" : \"gte\"\n },\n \"max_score\" : null,\n \"hits\" : [ ]\n }\n }\n}" -} \ No newline at end of file + "summary": "A successful response when performing search asynchronously.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\", <1>\n \"is_partial\" : true, <2>\n \"is_running\" : true, <3>\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"response\" : {\n \"took\" : 1122,\n \"timed_out\" : false,\n \"num_reduce_phases\" : 0,\n \"_shards\" : {\n \"total\" : 562, <4>\n \"successful\" : 3, <5>\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"hits\" : {\n \"total\" : {\n \"value\" : 157483, <6>\n \"relation\" : \"gte\"\n },\n \"max_score\" : null,\n \"hits\" : [ ]\n }\n }\n}" +} From 27b670a1685c6ba2ee2e218063611083d77feab3 Mon Sep 17 00:00:00 2001 From: lcawl Date: Fri, 9 Aug 2024 15:15:22 -0700 Subject: [PATCH 3/4] Add overlay for async_search.submit examples --- ...ticsearch-serverless-openapi-overlays.yaml | 20 ++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/docs/overlays/elasticsearch-serverless-openapi-overlays.yaml b/docs/overlays/elasticsearch-serverless-openapi-overlays.yaml index 0f9be46158..898a449f09 100644 --- a/docs/overlays/elasticsearch-serverless-openapi-overlays.yaml +++ b/docs/overlays/elasticsearch-serverless-openapi-overlays.yaml @@ -11,8 +11,24 @@ actions: **Technical preview** This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. + - target: "$.components['requestBodies']['async_search.submit']" + description: "Add example for asynch search submit request" + update: + content: + application/json: + examples: + asyncSearchSubmitResponseExample1: + $ref: "../../specification/async_search/submit/AsyncSearchSubmitRequestExample1.json" + - target: "$.components['responses']['async_search.submit#200']" + description: "Add example for asynch search submit response" + update: + content: + application/json: + examples: + asyncSearchSubmitResponseExample1: + $ref: "../../specification/async_search/submit/AsyncSearchSubmitResponseExample1.json" - target: "$.paths['/_transform/{transform_id}']['put']" - description: "Update create transform operation" + description: "Add examples for create transform operation" update: requestBody: content: @@ -29,5 +45,3 @@ actions: examples: createTransformResponseExample1: $ref: "../../specification/transform/put_transform/examples/200_response/PutTransformResponseExample1.json" - - From c01315c8f0107d1a6de833755eb3ef1946dc5c93 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Mon, 12 Aug 2024 11:01:44 +0200 Subject: [PATCH 4/4] Apply suggestions from code review --- .../async_search/get/AsyncSearchGetResponseExample1.json | 2 +- .../async_search/get/AsyncSearchGetResponseExample2.json | 2 +- .../async_search/get/AsyncSearchGetResponseExample3.json | 2 +- .../async_search/status/AsyncSearchStatusResponseExample1.json | 2 +- .../async_search/submit/AsyncSearchSubmitResponseExample1.json | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/specification/async_search/get/AsyncSearchGetResponseExample1.json b/specification/async_search/get/AsyncSearchGetResponseExample1.json index 7844cfa304..aadbdfd6c3 100644 --- a/specification/async_search/get/AsyncSearchGetResponseExample1.json +++ b/specification/async_search/get/AsyncSearchGetResponseExample1.json @@ -3,5 +3,5 @@ "description": "", "type": "response", "response_code": 200, - "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_partial\" : false, <1>\n \"is_running\" : false, <2>\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986, <3>\n \"completion_time_in_millis\" : 1583945903130, <4>\n \"response\" : {\n \"took\" : 12144,\n \"timed_out\" : false,\n \"num_reduce_phases\" : 46, <5>\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 188, <6>\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"hits\" : {\n \"total\" : {\n \"value\" : 456433,\n \"relation\" : \"eq\"\n },\n \"max_score\" : null,\n \"hits\" : [ ]\n },\n \"aggregations\" : { <7>\n \"sale_date\" : {\n \"buckets\" : []\n }\n }\n }\n}" + "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_partial\" : false,\n \"is_running\" : false,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"completion_time_in_millis\" : 1583945903130,\n \"response\" : {\n \"took\" : 12144,\n \"timed_out\" : false,\n \"num_reduce_phases\" : 46,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 188,\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"hits\" : {\n \"total\" : {\n \"value\" : 456433,\n \"relation\" : \"eq\"\n },\n \"max_score\" : null,\n \"hits\" : [ ]\n },\n \"aggregations\" : {\n \"sale_date\" : {\n \"buckets\" : []\n }\n }\n }\n}" } diff --git a/specification/async_search/get/AsyncSearchGetResponseExample2.json b/specification/async_search/get/AsyncSearchGetResponseExample2.json index 0ba475a36e..2b018a961e 100644 --- a/specification/async_search/get/AsyncSearchGetResponseExample2.json +++ b/specification/async_search/get/AsyncSearchGetResponseExample2.json @@ -3,5 +3,5 @@ "description": "For an async search that has been completed, the status response has an additional `completion_status` field that shows the status code of the completed async search which was – in this case – a success.", "type": "response", "response_code": 200, - "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : false,\n \"is_partial\" : false,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 562,\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"completion_status\" : 200 <1>\n}" + "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : false,\n \"is_partial\" : false,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 562,\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"completion_status\" : 200\n}" } diff --git a/specification/async_search/get/AsyncSearchGetResponseExample3.json b/specification/async_search/get/AsyncSearchGetResponseExample3.json index 05c6df49b1..b56220971c 100644 --- a/specification/async_search/get/AsyncSearchGetResponseExample3.json +++ b/specification/async_search/get/AsyncSearchGetResponseExample3.json @@ -3,5 +3,5 @@ "description": "For an async search that has been completed, the status response has an additional `completion_status` field that shows the status code of the completed async search which was completed – in this case – with an error.", "type": "response", "response_code": 200, - "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : false,\n \"is_partial\" : true,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 450,\n \"skipped\" : 0,\n \"failed\" : 112\n },\n \"completion_status\" : 503 <1>\n}" + "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : false,\n \"is_partial\" : true,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 450,\n \"skipped\" : 0,\n \"failed\" : 112\n },\n \"completion_status\" : 503\n}" } diff --git a/specification/async_search/status/AsyncSearchStatusResponseExample1.json b/specification/async_search/status/AsyncSearchStatusResponseExample1.json index d883c4a443..80b82b360f 100644 --- a/specification/async_search/status/AsyncSearchStatusResponseExample1.json +++ b/specification/async_search/status/AsyncSearchStatusResponseExample1.json @@ -3,5 +3,5 @@ "description": "", "type": "response", "response_code": 200, - "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : true,\n \"is_partial\" : true,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 188, <1>\n \"skipped\" : 0,\n \"failed\" : 0\n }\n}" + "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : true,\n \"is_partial\" : true,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 188,\n \"skipped\" : 0,\n \"failed\" : 0\n }\n}" } diff --git a/specification/async_search/submit/AsyncSearchSubmitResponseExample1.json b/specification/async_search/submit/AsyncSearchSubmitResponseExample1.json index 37028ba9e2..4cf7a5cdf9 100644 --- a/specification/async_search/submit/AsyncSearchSubmitResponseExample1.json +++ b/specification/async_search/submit/AsyncSearchSubmitResponseExample1.json @@ -3,5 +3,5 @@ "description": "", "type": "response", "response_code": 200, - "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\", <1>\n \"is_partial\" : true, <2>\n \"is_running\" : true, <3>\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"response\" : {\n \"took\" : 1122,\n \"timed_out\" : false,\n \"num_reduce_phases\" : 0,\n \"_shards\" : {\n \"total\" : 562, <4>\n \"successful\" : 3, <5>\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"hits\" : {\n \"total\" : {\n \"value\" : 157483, <6>\n \"relation\" : \"gte\"\n },\n \"max_score\" : null,\n \"hits\" : [ ]\n }\n }\n}" + "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_partial\" : true,\n \"is_running\" : true,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"response\" : {\n \"took\" : 1122,\n \"timed_out\" : false,\n \"num_reduce_phases\" : 0,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 3,\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"hits\" : {\n \"total\" : {\n \"value\" : 157483,\n \"relation\" : \"gte\"\n },\n \"max_score\" : null,\n \"hits\" : [ ]\n }\n }\n}" }