diff --git a/docs/overlays/elasticsearch-openapi-overlays.yaml b/docs/overlays/elasticsearch-openapi-overlays.yaml index f7f85da901..ffc1de32dd 100644 --- a/docs/overlays/elasticsearch-openapi-overlays.yaml +++ b/docs/overlays/elasticsearch-openapi-overlays.yaml @@ -9,6 +9,8 @@ actions: update: title: Elasticsearch API description: > + Elasticsearch provides REST APIs that are used by the UI components and can be called directly to configure and access Elasticsearch features. + ## Documentation source and versions This documentation is derived from the `8.x` branch of the [elasticsearch-specification](https://github.com/elastic/elasticsearch-specification) repository. diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index 885e7ae97a..aa281bca6e 100644 --- a/docs/overlays/elasticsearch-shared-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-overlays.yaml @@ -353,6 +353,17 @@ actions: externalDocs: url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html description: Query DSL + - target: "$.components['schemas']['_global.search._types:FieldCollapse']" + description: Add x-model and externalDocs + update: + x-model: true + externalDocs: + url: https://www.elastic.co/guide/en/elasticsearch/reference/master/collapse-search-results.html + - target: "$.components['schemas']['_global.msearch:MultisearchBody'].properties" + description: Add x-model + update: + aggregations: + x-model: true # Examples - target: "$.components['requestBodies']['async_search.submit']" description: "Add example for asynch search submit request" diff --git a/output/schema/schema.json b/output/schema/schema.json index 66ee64b4f5..8594ee1680 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -27507,7 +27507,7 @@ } } ], - "specLocation": "_global/msearch/types.ts#L213-L216" + "specLocation": "_global/msearch/types.ts#L216-L219" }, { "kind": "interface", @@ -27557,7 +27557,7 @@ } } ], - "specLocation": "_global/msearch/types.ts#L203-L206" + "specLocation": "_global/msearch/types.ts#L206-L209" }, { "kind": "interface", @@ -27570,6 +27570,7 @@ "aliases": [ "aggs" ], + "extDocId": "search-aggregations", "name": "aggregations", "required": false, "type": { @@ -28029,7 +28030,7 @@ } } ], - "specLocation": "_global/msearch/types.ts#L70-L201" + "specLocation": "_global/msearch/types.ts#L70-L204" }, { "kind": "interface", @@ -28455,7 +28456,7 @@ "name": "ResponseItem", "namespace": "_global.msearch" }, - "specLocation": "_global/msearch/types.ts#L208-L211", + "specLocation": "_global/msearch/types.ts#L211-L214", "type": { "kind": "union_of", "items": [ @@ -35092,6 +35093,8 @@ }, { "kind": "interface", + "extDocId": "collapse-search-results", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/collapse-search-results.html", "name": { "name": "FieldCollapse", "namespace": "_global.search._types" @@ -35160,7 +35163,7 @@ } } ], - "specLocation": "_global/search/_types/FieldCollapse.ts#L24-L38" + "specLocation": "_global/search/_types/FieldCollapse.ts#L24-L41" }, { "kind": "interface", diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index ca10e4db29..3c4df835c7 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -80,6 +80,7 @@ cluster,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster common-options,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html community-id-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/community-id-processor.html connector-sync-job-cancel,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cancel-connector-sync-job-api.html +collapse-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/collapse-search-results.html connector-sync-job-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-connector-sync-job-api.html connector-sync-job-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-sync-job-api.html connector-sync-job-post,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-sync-job-api.html diff --git a/specification/_global/msearch/types.ts b/specification/_global/msearch/types.ts index bfc20059ac..ec6efbf38b 100644 --- a/specification/_global/msearch/types.ts +++ b/specification/_global/msearch/types.ts @@ -68,7 +68,10 @@ export class MultisearchHeader { // We should keep this in sync with the normal search request body. export class MultisearchBody { - /** @aliases aggs */ // ES uses "aggregations" in serialization + /** + * @aliases aggs + * @ext_doc_id search-aggregations + */ // ES uses "aggregations" in serialization aggregations?: Dictionary collapse?: FieldCollapse /** diff --git a/specification/_global/search/_types/FieldCollapse.ts b/specification/_global/search/_types/FieldCollapse.ts index bc867ad4d8..2afdd7baee 100644 --- a/specification/_global/search/_types/FieldCollapse.ts +++ b/specification/_global/search/_types/FieldCollapse.ts @@ -21,6 +21,9 @@ import { Field } from '@_types/common' import { integer } from '@_types/Numeric' import { InnerHits } from './hits' +/** + * @ext_doc_id collapse-search-results + */ export class FieldCollapse { /** * The field to collapse the result set on