diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 8b6c4d866f..0e8ad68982 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -50662,6 +50662,9 @@ "type": "object", "properties": { "aggregations": { + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/aggregations" + }, "description": "Defines the aggregations that are run as part of the search request.", "type": "object", "additionalProperties": { @@ -116613,6 +116616,9 @@ "type": "object", "properties": { "aggregations": { + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/aggregations" + }, "description": "Defines the aggregations that are run as part of the search request.", "type": "object", "additionalProperties": { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 61aa84a7b7..0d2cc11174 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -29869,6 +29869,9 @@ "type": "object", "properties": { "aggregations": { + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/aggregations" + }, "description": "Defines the aggregations that are run as part of the search request.", "type": "object", "additionalProperties": { @@ -69483,6 +69486,9 @@ "type": "object", "properties": { "aggregations": { + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/aggregations" + }, "description": "Defines the aggregations that are run as part of the search request.", "type": "object", "additionalProperties": { diff --git a/output/schema/schema.json b/output/schema/schema.json index 2d5913389e..dfd2ddc09e 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -34980,6 +34980,8 @@ "aggs" ], "description": "Defines the aggregations that are run as part of the search request.", + "extDocId": "search-aggregations", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/aggregations", "name": "aggregations", "required": false, "type": { @@ -35060,6 +35062,8 @@ }, { "description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.", + "extDocId": "search-highlight", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting", "name": "highlight", "required": false, "type": { @@ -35269,6 +35273,8 @@ } }, "description": "A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.", + "extDocId": "search-retrievers", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers", "name": "retriever", "required": false, "type": { @@ -36156,7 +36162,7 @@ } } ], - "specLocation": "_global/search/SearchRequest.ts#L53-L584" + "specLocation": "_global/search/SearchRequest.ts#L53-L588" }, { "kind": "response", @@ -41074,6 +41080,8 @@ "aggs" ], "description": "Defines the aggregations that are run as part of the search request.", + "extDocId": "search-aggregations", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/aggregations", "name": "aggregations", "required": false, "type": { @@ -41154,6 +41162,8 @@ }, { "description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.", + "extDocId": "search-highlight", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting", "name": "highlight", "required": false, "type": { @@ -41363,6 +41373,8 @@ } }, "description": "A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.", + "extDocId": "search-retrievers", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers", "name": "retriever", "required": false, "type": { @@ -41609,7 +41621,7 @@ } } ], - "specLocation": "_global/search/_types/SearchRequestBody.ts#L42-L238" + "specLocation": "_global/search/_types/SearchRequestBody.ts#L42-L242" }, { "kind": "interface", diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 6ca978b0d1..013c74b7b4 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -709,10 +709,12 @@ search-render-query,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operati search-count,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-count search-explain,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-explain search-field-caps,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-field-caps +search-highlight,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting search-knn,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-knn-search search-multi-search,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-msearch search-multi-search-template,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-msearch-template search-rank-eval,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-rank-eval +search-retrievers,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers search-search,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search search-shards,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-shards search-template,https://www.elastic.co/docs/solutions/search/search-templates diff --git a/specification/_global/search/SearchRequest.ts b/specification/_global/search/SearchRequest.ts index cee2a0b5cc..5e61acf27d 100644 --- a/specification/_global/search/SearchRequest.ts +++ b/specification/_global/search/SearchRequest.ts @@ -387,7 +387,9 @@ export interface Request extends RequestBase { body: { /** * Defines the aggregations that are run as part of the search request. - * @aliases aggs */ // ES uses "aggregations" in serialization + * @aliases aggs + * @ext_doc_id search-aggregations + */ // ES uses "aggregations" in serialization aggregations?: Dictionary /** * Collapses search results the values of the specified field. @@ -411,6 +413,7 @@ export interface Request extends RequestBase { from?: integer /** * Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. + * @ext_doc_id search-highlight */ highlight?: Highlight /** @@ -477,6 +480,7 @@ export interface Request extends RequestBase { * A retriever replaces other elements of the search API that also return top documents such as `query` and `knn`. * @availability stack since=8.14.0 stability=stable * @availability serverless stability=stable + * @ext_doc_id search-retrievers */ retriever?: RetrieverContainer /** diff --git a/specification/_global/search/_types/SearchRequestBody.ts b/specification/_global/search/_types/SearchRequestBody.ts index 373c1cc1b0..097207a1b5 100644 --- a/specification/_global/search/_types/SearchRequestBody.ts +++ b/specification/_global/search/_types/SearchRequestBody.ts @@ -42,7 +42,9 @@ import { Sort, SortResults } from '@_types/sort' export class SearchRequestBody { /** * Defines the aggregations that are run as part of the search request. - * @aliases aggs */ // ES uses "aggregations" in serialization + * @aliases aggs + * @ext_doc_id search-aggregations + */ // ES uses "aggregations" in serialization aggregations?: Dictionary /** * Collapses search results the values of the specified field. @@ -66,6 +68,7 @@ export class SearchRequestBody { from?: integer /** * Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. + * @ext_doc_id search-highlight */ highlight?: Highlight /** @@ -132,6 +135,7 @@ export class SearchRequestBody { * A retriever replaces other elements of the search API that also return top documents such as `query` and `knn`. * @availability stack since=8.14.0 stability=stable * @availability serverless stability=stable + * @ext_doc_id search-retrievers */ retriever?: RetrieverContainer /**