Update rest-api-spec

elastic · Nov 26, 2024 · a26342c · a26342c
1 parent 7607c0d
commit a26342c
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
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"