Skip to content

Commit b591f49

Browse files
Update specs for ES|QL include_execution_metadata (#5655)
1 parent dc5758f commit b591f49

File tree

5 files changed

+59
-10
lines changed

5 files changed

+59
-10
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 10 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/openapi/elasticsearch-serverless-openapi.json

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 28 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/esql/async_query/AsyncQueryRequest.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,9 +117,16 @@ export interface Request extends RequestBase {
117117
* object with information about the clusters that participated in the search along with info such as shards
118118
* count.
119119
* @server_default false
120-
* @aliases include_execution_metadata
121120
*/
122121
include_ccs_metadata?: boolean
122+
/**
123+
* When set to `true`, the response will include an extra `_clusters`
124+
* object with information about the clusters that participated in the search along with info such as shards
125+
* count.
126+
* This is similar to `include_ccs_metadata`, but it also returns metadata when the query is not CCS/CPS
127+
* @server_default false
128+
*/
129+
include_execution_metadata?: boolean
123130
/**
124131
* The period to wait for the request to finish.
125132
* By default, the request waits for 1 second for the query results.

specification/esql/query/QueryRequest.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,15 @@ export interface Request extends RequestBase {
110110
* object with information about the clusters that participated in the search along with info such as shards
111111
* count.
112112
* @server_default false
113-
* @aliases include_execution_metadata
114113
*/
115114
include_ccs_metadata?: boolean
115+
/**
116+
* When set to `true`, the response will include an extra `_clusters`
117+
* object with information about the clusters that participated in the search along with info such as shards
118+
* count.
119+
* This is similar to `include_ccs_metadata`, but it also returns metadata when the query is not CCS/CPS
120+
* @server_default false
121+
*/
122+
include_execution_metadata?: boolean
116123
}
117124
}

0 commit comments

Comments
 (0)