Add missing include_ccs_metadata to ES|QL query endpoints (#3743)

* Add missing `include_ccs_metadata` to ES|QL query endpoints * Address review comments * Regenerate output --------- Co-authored-by: lcawl <[email protected]>
elastic · Feb 11, 2025 · 6b15af9 · 6b15af9
1 parent 0efbba5
commit 6b15af9
Show file tree

Hide file tree

Showing 9 changed files with 84 additions and 6 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/typescript/types.ts b/output/typescript/types.ts
diff --git a/specification/esql/async_query/AsyncQueryRequest.ts b/specification/esql/async_query/AsyncQueryRequest.ts
@@ -114,5 +114,12 @@ export interface Request extends RequestBase {
      * name and the next level key is the column name.
      */
     tables?: Dictionary<string, Dictionary<string, TableValuesContainer>>
+    /**
+     * When set to `true` and performing a cross-cluster query, the response will include an extra `_clusters`
+     * object with information about the clusters that participated in the search along with info such as shards
+     * count.
+     * @server_default false
+     */
+    include_ccs_metadata?: boolean
   }
 }
diff --git a/specification/esql/async_query/examples/request/AsyncQueryRequestExample1.yaml b/specification/esql/async_query/examples/request/AsyncQueryRequestExample1.yaml
@@ -2,4 +2,15 @@
 # method_request: "POST /_query/async"
 # description:
 # type: request
-value: "{\n  \"query\": \"\"\"\n    FROM library\n    | EVAL year = DATE_TRUNC(1 YEARS, release_date)\n    | STATS MAX(page_count) BY year\n    | SORT year\n    | LIMIT 5\n  \"\"\",\n  \"wait_for_completion_timeout\": \"2s\"\n}"
+value: |-
+  {
+    "query": """
+      FROM library,remote-*:library
+      | EVAL year = DATE_TRUNC(1 YEARS, release_date)
+      | STATS MAX(page_count) BY year
+      | SORT year
+      | LIMIT 5
+    """,
+    "wait_for_completion_timeout": "2s",
+    "include_ccs_metadata": true
+  }
diff --git a/specification/esql/query/QueryRequest.ts b/specification/esql/query/QueryRequest.ts
@@ -94,5 +94,12 @@ export interface Request extends RequestBase {
      * name and the next level key is the column name.
      */
     tables?: Dictionary<string, Dictionary<string, TableValuesContainer>>
+    /**
+     * When set to `true` and performing a cross-cluster query, the response will include an extra `_clusters`
+     * object with information about the clusters that participated in the search along with info such as shards
+     * count.
+     * @server_default false
+     */
+    include_ccs_metadata?: boolean
   }
 }
diff --git a/specification/esql/query/examples/request/QueryRequestExample1.yaml b/specification/esql/query/examples/request/QueryRequestExample1.yaml
@@ -5,10 +5,11 @@ description: Run `POST /_query` to get results for an ES|QL query.
 value: |-
   {
     "query": """
-      FROM library
+      FROM library,remote-*:library
       | EVAL year = DATE_TRUNC(1 YEARS, release_date)
       | STATS MAX(page_count) BY year
       | SORT year
       | LIMIT 5
-    """
+    """,
+    "include_ccs_metadata": true
   }