Update rest-api-spec main (#3175)

Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>
elastic · Nov 26, 2024 · 71e3fa5 · 71e3fa5
1 parent 7dc96a3
commit 71e3fa5
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 3 deletions.
diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json
diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json
@@ -57,10 +57,7 @@
     },
     "async_search.submit": {
       "request": [
-        "Request: query parameter 'ccs_minimize_roundtrips' does not exist in the json spec",
-        "Request: query parameter 'pre_filter_shard_size' does not exist in the json spec",
         "Request: query parameter 'scroll' does not exist in the json spec",
-        "Request: query parameter 'rest_total_hits_as_int' does not exist in the json spec",
         "interface definition _types:QueryVectorBuilder - Property text_embedding is a single-variant and must be required",
         "type_alias definition _spec_utils:PipeSeparatedFlags / union_of / instance_of - No type definition for '_spec_utils.PipeSeparatedFlags:T'"
       ],

diff --git a/specification/_json_spec/async_search.submit.json b/specification/_json_spec/async_search.submit.json
@@ -61,6 +61,11 @@
         "type": "boolean",
         "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)"
       },
+      "ccs_minimize_roundtrips": {
+        "type": "boolean",
+        "default": false,
+        "description": "When doing a cross-cluster search, setting it to true may improve overall search latency, particularly when searching clusters with a large number of shards. However, when set to true, the progress of searches on the remote clusters will not be received until the search finishes on all clusters."
+      },
       "default_operator": {
         "type": "enum",
         "options": ["AND", "OR"],
@@ -113,6 +118,16 @@
         "type": "string",
         "description": "Specify the node or shard the operation should be performed on (default: random)"
       },
+      "pre_filter_shard_size": {
+        "type": "number",
+        "default": 1,
+        "description": "Cannot be changed: this is to enforce the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped."
+      },
+      "rest_total_hits_as_int": {
+        "type": "boolean",
+        "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response",
+        "default": false
+      },
       "q": {
         "type": "string",
         "description": "Query in the Lucene query string syntax"