Skip to content

Commit de4ff9e

Browse files
authored
ESQL: Update text formats documentation (#5054) (#5060)
Spec docs update for the ESQL `format` parameter. Text formats result in missing metadata in the response body. Main docs change: elastic/docs-content#2307 (cherry picked from commit a04b872)
1 parent 6a74923 commit de4ff9e

File tree

6 files changed

+36
-15
lines changed

6 files changed

+36
-15
lines changed

output/openapi/elasticsearch-openapi.json

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

output/schema/schema.json

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

specification/esql/_types/EsqlResult.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,17 @@ export class EsqlResult {
4343
}
4444

4545
export class AsyncEsqlResult extends EsqlResult {
46+
/**
47+
* The ID of the async query, to be used in subsequent requests to check the status or retrieve results.
48+
*
49+
* Also available in the `X-Elasticsearch-Async-Id` HTTP header.
50+
*/
4651
id?: string
52+
/**
53+
* Indicates whether the async query is still running or has completed.
54+
*
55+
* Also available in the `X-Elasticsearch-Async-Is-Running` HTTP header.
56+
*/
4757
is_running: boolean
4858
}
4959

specification/esql/async_query/AsyncQueryRequest.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,12 @@ export interface Request extends RequestBase {
5050
*/
5151
drop_null_columns?: boolean
5252
/**
53-
* A short version of the Accept header, for example `json` or `yaml`.
53+
* A short version of the Accept header, e.g. json, yaml.
54+
*
55+
* `csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.
56+
*
57+
* For async requests, nothing will be returned if the async query doesn't finish within the timeout.
58+
* The query ID and running status are available in the `X-Elasticsearch-Async-Id` and `X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively.
5459
*/
5560
format?: EsqlFormat
5661
}

specification/esql/query/QueryRequest.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ export interface Request extends RequestBase {
4343
query_parameters: {
4444
/**
4545
* A short version of the Accept header, e.g. json, yaml.
46+
*
47+
* `csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.
4648
*/
4749
format?: EsqlFormat
4850
/**

0 commit comments

Comments
 (0)