diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index d6428c82a6..190b2e96f8 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -10630,6 +10630,11 @@ "default": false, "type": "boolean" }, + "include_execution_metadata": { + "description": "When set to `true`, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.\nThis is similar to `include_ccs_metadata`, but it also returns metadata when the query is not CCS/CPS", + "default": false, + "type": "boolean" + }, "wait_for_completion_timeout": { "description": "The period to wait for the request to finish.\nBy default, the request waits for 1 second for the query results.\nIf the query completes during this period, results are returned\nOtherwise, a query ID is returned that can later be used to retrieve the results.", "default": "1s", @@ -11101,6 +11106,11 @@ "description": "When set to `true` and performing a cross-cluster/cross-project query, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.", "default": false, "type": "boolean" + }, + "include_execution_metadata": { + "description": "When set to `true`, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.\nThis is similar to `include_ccs_metadata`, but it also returns metadata when the query is not CCS/CPS", + "default": false, + "type": "boolean" } }, "required": [ diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index a3eabd59ce..c9b00850f0 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -6513,6 +6513,11 @@ "description": "When set to `true` and performing a cross-cluster/cross-project query, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.", "default": false, "type": "boolean" + }, + "include_execution_metadata": { + "description": "When set to `true`, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.\nThis is similar to `include_ccs_metadata`, but it also returns metadata when the query is not CCS/CPS", + "default": false, + "type": "boolean" } }, "required": [ diff --git a/output/schema/schema.json b/output/schema/schema.json index 9789e496ec..9c931feaad 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -142782,9 +142782,6 @@ } }, { - "aliases": [ - "include_execution_metadata" - ], "description": "When set to `true` and performing a cross-cluster/cross-project query, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.", "name": "include_ccs_metadata", "required": false, @@ -142797,6 +142794,19 @@ } } }, + { + "description": "When set to `true`, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.\nThis is similar to `include_ccs_metadata`, but it also returns metadata when the query is not CCS/CPS", + "name": "include_execution_metadata", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, { "description": "The period to wait for the request to finish.\nBy default, the request waits for 1 second for the query results.\nIf the query completes during this period, results are returned\nOtherwise, a query ID is returned that can later be used to retrieve the results.", "name": "wait_for_completion_timeout", @@ -142931,7 +142941,7 @@ } } ], - "specLocation": "esql/async_query/AsyncQueryRequest.ts#L28-L146" + "specLocation": "esql/async_query/AsyncQueryRequest.ts#L28-L153" }, { "kind": "response", @@ -143633,9 +143643,6 @@ } }, { - "aliases": [ - "include_execution_metadata" - ], "description": "When set to `true` and performing a cross-cluster/cross-project query, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.", "name": "include_ccs_metadata", "required": false, @@ -143647,6 +143654,19 @@ "namespace": "_builtins" } } + }, + { + "description": "When set to `true`, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.\nThis is similar to `include_ccs_metadata`, but it also returns metadata when the query is not CCS/CPS", + "name": "include_execution_metadata", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ] }, @@ -143748,7 +143768,7 @@ } } ], - "specLocation": "esql/query/QueryRequest.ts#L27-L117" + "specLocation": "esql/query/QueryRequest.ts#L27-L124" }, { "kind": "response", diff --git a/specification/esql/async_query/AsyncQueryRequest.ts b/specification/esql/async_query/AsyncQueryRequest.ts index 020c182ef3..4f552ca877 100644 --- a/specification/esql/async_query/AsyncQueryRequest.ts +++ b/specification/esql/async_query/AsyncQueryRequest.ts @@ -117,9 +117,16 @@ export interface Request extends RequestBase { * object with information about the clusters that participated in the search along with info such as shards * count. * @server_default false - * @aliases include_execution_metadata */ include_ccs_metadata?: boolean + /** + * When set to `true`, 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. + * This is similar to `include_ccs_metadata`, but it also returns metadata when the query is not CCS/CPS + * @server_default false + */ + include_execution_metadata?: boolean /** * The period to wait for the request to finish. * By default, the request waits for 1 second for the query results. diff --git a/specification/esql/query/QueryRequest.ts b/specification/esql/query/QueryRequest.ts index 05cb9b9c7d..0e22f2d9fe 100644 --- a/specification/esql/query/QueryRequest.ts +++ b/specification/esql/query/QueryRequest.ts @@ -110,8 +110,15 @@ export interface Request extends RequestBase { * object with information about the clusters that participated in the search along with info such as shards * count. * @server_default false - * @aliases include_execution_metadata */ include_ccs_metadata?: boolean + /** + * When set to `true`, 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. + * This is similar to `include_ccs_metadata`, but it also returns metadata when the query is not CCS/CPS + * @server_default false + */ + include_execution_metadata?: boolean } }