diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index d047359c77..30cb7ee19f 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -7813,7 +7813,11 @@ "tags": [ "esql" ], - "summary": "Executes an ES|QL request", + "summary": "Run an ES|QL query", + "description": "Get search results for an ES|QL (Elasticsearch query language) query.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html" + }, "operationId": "esql-query", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index ea451298bc..6096b8b2cd 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -4972,7 +4972,11 @@ "tags": [ "esql" ], - "summary": "Executes an ES|QL request", + "summary": "Run an ES|QL query", + "description": "Get search results for an ES|QL (Elasticsearch query language) query.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html" + }, "operationId": "esql-query", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index caa54b9fc4..14ff4eb44d 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -4801,9 +4801,11 @@ "since": "8.11.0" } }, - "description": "Executes an ES|QL request", + "description": "Run an ES|QL query.\nGet search results for an ES|QL (Elasticsearch query language) query.", "docId": "esql-query", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html", + "extDocId": "esql", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql.html", "name": "esql.query", "request": { "name": "Request", @@ -118363,7 +118365,7 @@ "name": "EsqlFormat", "namespace": "esql.query" }, - "specLocation": "esql/query/QueryRequest.ts#L91-L100" + "specLocation": "esql/query/QueryRequest.ts#L93-L102" }, { "kind": "request", @@ -118485,7 +118487,7 @@ } ] }, - "description": "Executes an ES|QL request", + "description": "Run an ES|QL query.\nGet search results for an ES|QL (Elasticsearch query language) query.", "inherits": { "type": { "name": "RequestBase", @@ -118536,7 +118538,7 @@ } } ], - "specLocation": "esql/query/QueryRequest.ts#L26-L89" + "specLocation": "esql/query/QueryRequest.ts#L26-L91" }, { "kind": "response", diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 02c04d4df9..28e1e06073 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -151,6 +151,7 @@ eql-sequences,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/e eql-missing-events,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html#eql-missing-events eql-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html eql,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html +esql,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql.html esql-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html esql-query-params,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html#esql-rest-params esql-returning-localized-results,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html#esql-locale-param diff --git a/specification/esql/query/QueryRequest.ts b/specification/esql/query/QueryRequest.ts index 44ba0d0953..2c56dc5914 100644 --- a/specification/esql/query/QueryRequest.ts +++ b/specification/esql/query/QueryRequest.ts @@ -24,11 +24,13 @@ import { FieldValue } from '@_types/common' import { QueryContainer } from '@_types/query_dsl/abstractions' /** - * Executes an ES|QL request + * Run an ES|QL query. + * Get search results for an ES|QL (Elasticsearch query language) query. * @rest_spec_name esql.query * @availability stack since=8.11.0 * @availability serverless * @doc_id esql-query + * @ext_doc_id esql */ export interface Request extends RequestBase { query_parameters: {