diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index 5d799e2f23..de68d1e032 100644 --- a/docs/overlays/elasticsearch-shared-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-overlays.yaml @@ -1071,6 +1071,15 @@ actions: # update: # aggregations: # x-model: true + - target: "$.components['schemas']['_types.ScriptSource'].oneOf" + description: Remove oneOf temporarily from ScriptSource + remove: true + - target: "$.components['schemas']['_types.ScriptSource']" + description: Re-add simplified oneOf temporarily in ScriptSource + update: + oneOf: + - type: string + - type: object # Examples ## xCodeSamples - target: "$.paths['/{index}/_doc/{id}']['head']" diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index e1f0270f8c..22fd0d70d1 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -50782,6 +50782,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": { @@ -116816,6 +116819,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 514a11cef7..7e67bd81d9 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -29985,6 +29985,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": { @@ -69686,6 +69689,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 62d3a292c3..81a944ac88 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -35149,6 +35149,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": { @@ -35229,6 +35231,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": { @@ -35438,6 +35442,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": { @@ -36325,7 +36331,7 @@ } } ], - "specLocation": "_global/search/SearchRequest.ts#L53-L584" + "specLocation": "_global/search/SearchRequest.ts#L53-L588" }, { "kind": "response", @@ -41243,6 +41249,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": { @@ -41323,6 +41331,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": { @@ -41532,6 +41542,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": { @@ -41778,7 +41790,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 e6815ca8de..bc6ca26e6a 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -706,9 +706,11 @@ search-application-get,https://www.elastic.co/docs/api/doc/elasticsearch/operati search-application-put,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put search-application-search,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-search search-render-query,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-render-query +search-retrievers,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers search-count,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-count search-explain,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-explain search-field-caps,https://www.elastic.co/docs/api/doc/elasticsearch/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/operation/operation-knn-search search-multi-search,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch search-multi-search-template,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch-template 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 /**