diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 7aa6f5865e..44e00833df 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -10511,7 +10511,7 @@ { "in": "query", "name": "format", - "description": "A short version of the Accept header, for example `json` or `yaml`.", + "description": "A short version of the Accept header, e.g. json, yaml.\n\n`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.\n\nFor async requests, nothing will be returned if the async query doesn't finish within the timeout.\nThe 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.", "deprecated": false, "schema": { "$ref": "#/components/schemas/esql.query.EsqlFormat" @@ -10809,7 +10809,7 @@ { "in": "query", "name": "format", - "description": "A short version of the Accept header, e.g. json, yaml.", + "description": "A short version of the Accept header, e.g. json, yaml.\n\n`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.", "deprecated": false, "schema": { "$ref": "#/components/schemas/esql.query.EsqlFormat" @@ -81776,9 +81776,11 @@ "type": "object", "properties": { "id": { + "description": "The ID of the async query, to be used in subsequent requests to check the status or retrieve results.\n\nAlso available in the `X-Elasticsearch-Async-Id` HTTP header.", "type": "string" }, "is_running": { + "description": "Indicates whether the async query is still running or has completed.\n\nAlso available in the `X-Elasticsearch-Async-Is-Running` HTTP header.", "type": "boolean" } }, diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index ec77a17ae6..117e5fc3f9 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -6131,7 +6131,7 @@ { "in": "query", "name": "format", - "description": "A short version of the Accept header, e.g. json, yaml.", + "description": "A short version of the Accept header, e.g. json, yaml.\n\n`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.", "deprecated": false, "schema": { "$ref": "#/components/schemas/esql.query.EsqlFormat" diff --git a/output/schema/schema.json b/output/schema/schema.json index 038b8989bd..392f3f1a40 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -136445,6 +136445,7 @@ }, "properties": [ { + "description": "The ID of the async query, to be used in subsequent requests to check the status or retrieve results.\n\nAlso available in the `X-Elasticsearch-Async-Id` HTTP header.", "name": "id", "required": false, "type": { @@ -136456,6 +136457,7 @@ } }, { + "description": "Indicates whether the async query is still running or has completed.\n\nAlso available in the `X-Elasticsearch-Async-Is-Running` HTTP header.", "name": "is_running", "required": true, "type": { @@ -136467,7 +136469,7 @@ } } ], - "specLocation": "esql/_types/EsqlResult.ts#L45-L48" + "specLocation": "esql/_types/EsqlResult.ts#L45-L58" }, { "kind": "interface", @@ -136530,7 +136532,7 @@ } } ], - "specLocation": "esql/_types/EsqlResult.ts#L65-L70" + "specLocation": "esql/_types/EsqlResult.ts#L75-L80" }, { "kind": "interface", @@ -136628,7 +136630,7 @@ } } ], - "specLocation": "esql/_types/EsqlResult.ts#L55-L63" + "specLocation": "esql/_types/EsqlResult.ts#L65-L73" }, { "kind": "enum", @@ -136653,7 +136655,7 @@ "name": "EsqlClusterStatus", "namespace": "esql._types" }, - "specLocation": "esql/_types/EsqlResult.ts#L72-L78" + "specLocation": "esql/_types/EsqlResult.ts#L82-L88" }, { "kind": "interface", @@ -136685,7 +136687,7 @@ } } ], - "specLocation": "esql/_types/EsqlResult.ts#L50-L53" + "specLocation": "esql/_types/EsqlResult.ts#L60-L63" }, { "kind": "interface", @@ -136845,7 +136847,7 @@ } } ], - "specLocation": "esql/_types/EsqlResult.ts#L88-L93" + "specLocation": "esql/_types/EsqlResult.ts#L98-L103" }, { "kind": "interface", @@ -136913,7 +136915,7 @@ } } ], - "specLocation": "esql/_types/EsqlResult.ts#L80-L86" + "specLocation": "esql/_types/EsqlResult.ts#L90-L96" }, { "kind": "interface", @@ -137356,7 +137358,7 @@ } }, { - "description": "A short version of the Accept header, for example `json` or `yaml`.", + "description": "A short version of the Accept header, e.g. json, yaml.\n\n`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.\n\nFor async requests, nothing will be returned if the async query doesn't finish within the timeout.\nThe 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.", "name": "format", "required": false, "type": { @@ -137368,7 +137370,7 @@ } } ], - "specLocation": "esql/async_query/AsyncQueryRequest.ts#L28-L133" + "specLocation": "esql/async_query/AsyncQueryRequest.ts#L28-L138" }, { "kind": "response", @@ -137909,7 +137911,7 @@ "path": [], "query": [ { - "description": "A short version of the Accept header, e.g. json, yaml.", + "description": "A short version of the Accept header, e.g. json, yaml.\n\n`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.", "name": "format", "required": false, "type": { @@ -137959,7 +137961,7 @@ } } ], - "specLocation": "esql/query/QueryRequest.ts#L27-L113" + "specLocation": "esql/query/QueryRequest.ts#L27-L115" }, { "kind": "response", diff --git a/specification/esql/_types/EsqlResult.ts b/specification/esql/_types/EsqlResult.ts index 6a7cefa8bd..4afbd092bf 100644 --- a/specification/esql/_types/EsqlResult.ts +++ b/specification/esql/_types/EsqlResult.ts @@ -43,7 +43,17 @@ export class EsqlResult { } export class AsyncEsqlResult extends EsqlResult { + /** + * The ID of the async query, to be used in subsequent requests to check the status or retrieve results. + * + * Also available in the `X-Elasticsearch-Async-Id` HTTP header. + */ id?: string + /** + * Indicates whether the async query is still running or has completed. + * + * Also available in the `X-Elasticsearch-Async-Is-Running` HTTP header. + */ is_running: boolean } diff --git a/specification/esql/async_query/AsyncQueryRequest.ts b/specification/esql/async_query/AsyncQueryRequest.ts index 97b07a5bf3..9521795fe1 100644 --- a/specification/esql/async_query/AsyncQueryRequest.ts +++ b/specification/esql/async_query/AsyncQueryRequest.ts @@ -58,7 +58,12 @@ export interface Request extends RequestBase { */ drop_null_columns?: boolean /** - * A short version of the Accept header, for example `json` or `yaml`. + * A short version of the Accept header, e.g. json, yaml. + * + * `csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response. + * + * For async requests, nothing will be returned if the async query doesn't finish within the timeout. + * 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. */ format?: EsqlFormat } diff --git a/specification/esql/query/QueryRequest.ts b/specification/esql/query/QueryRequest.ts index 2ec14061d8..824cd7f80b 100644 --- a/specification/esql/query/QueryRequest.ts +++ b/specification/esql/query/QueryRequest.ts @@ -43,6 +43,8 @@ export interface Request extends RequestBase { query_parameters: { /** * A short version of the Accept header, e.g. json, yaml. + * + * `csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response. */ format?: EsqlFormat /**