Skip to content

Commit 6180ad4

Browse files
authored
Fix most esql.query request types (#2671)
1 parent 076b8b0 commit 6180ad4

File tree

8 files changed

+98
-12
lines changed

8 files changed

+98
-12
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 14 additions & 1 deletion
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: 14 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema-serverless.json

Lines changed: 26 additions & 2 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: 26 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/validation-errors.json

Lines changed: 1 addition & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/typescript/types.ts

Lines changed: 3 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_doc_ids/table.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ eql-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-
148148
eql,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html
149149
esql-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html
150150
esql-query-params,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html#esql-rest-params
151+
esql-returning-localized-results,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html#esql-locale-param
151152
evaluate-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/evaluate-dfanalytics.html
152153
execute-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/execute-enrich-policy-api.html
153154
expected-reciprocal,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_expected_reciprocal_rank_err

specification/esql/query/QueryRequest.ts

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
import { RequestBase } from '@_types/Base'
2121
import { QueryContainer } from '@_types/query_dsl/abstractions'
22-
import { ScalarValue } from '@_types/common'
22+
import { FieldValue } from '@_types/common'
2323

2424
/**
2525
* Executes an ES|QL request
@@ -38,6 +38,12 @@ export interface Request extends RequestBase {
3838
* The character to use between values within a CSV row. Only valid for the CSV format.
3939
*/
4040
delimiter?: string
41+
/**
42+
* Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?
43+
* Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns.
44+
* @server_default false
45+
*/
46+
drop_null_columns?: boolean
4147
}
4248
/**
4349
* Use the `query` element to start a query. Use `time_zone` to specify an execution time zone and `columnar` to format the answer.
@@ -51,12 +57,17 @@ export interface Request extends RequestBase {
5157
* Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on.
5258
*/
5359
filter?: QueryContainer
60+
/*
61+
* Returns results (especially dates) formatted per the conventions of the locale.
62+
* @doc_id esql-returning-localized-results
63+
*/
5464
locale?: string
5565
/**
5666
* To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.
5767
* @doc_id esql-query-params
5868
*/
59-
params?: Array<ScalarValue>
69+
params?: Array<FieldValue>
70+
profile?: boolean
6071
/**
6172
* The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results.
6273
*/

0 commit comments

Comments
 (0)