Skip to content

Commit 51cf140

Browse files
authored
Merge branch '8.16' into backport-3056-to-8.16
2 parents 158cc48 + c0d9ddb commit 51cf140

File tree

42 files changed

+597
-353
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+597
-353
lines changed

docs/overlays/elasticsearch-openapi-overlays.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@ actions:
99
update:
1010
title: Elasticsearch API
1111
description: >
12+
Elasticsearch provides REST APIs that are used by the UI components and can be called directly to configure and access Elasticsearch features.
13+
1214
## Documentation source and versions
1315
14-
This documentation is derived from the `8.x` branch of the [elasticsearch-specification](https://github.com/elastic/elasticsearch-specification) repository.
16+
This documentation is derived from the `8.16` branch of the [elasticsearch-specification](https://github.com/elastic/elasticsearch-specification) repository.
1517
It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/).
1618
x-doc-license:
1719
name: Attribution-NonCommercial-NoDerivatives 4.0 International

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 39 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -35,26 +35,28 @@ actions:
3535
3636
Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure:
3737
38-
* Native connectors are a managed service on Elastic Cloud
39-
* Connector clients are self-managed on your infrastructure
38+
* Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud
39+
40+
* Self-managed connectors (Connector clients) are self-managed on your infrastructure.
41+
4042
4143
This API provides an alternative to relying solely on Kibana UI for connector and sync job management. The API comes with a set of validations and assertions to ensure that the state representation in the internal index remains valid.
4244
externalDocs:
43-
url: https://www.elastic.co/guide/en/enterprise-search/current/connectors-tutorial-api.html
44-
description: To get started with Connector APIs, check out the tutorial.
45+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/es-connectors-tutorial-api.html
46+
description: Connector API tutorial
4547
- name: ccr
4648
x-displayName: Cross-cluster replication
4749
# D
4850
- name: data stream
4951
x-displayName: Data stream
5052
externalDocs:
5153
description: Data stream overview
52-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html
54+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams.html
5355
- name: document
5456
x-displayName: Document
5557
externalDocs:
5658
description: Reading and writing documents
57-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-replication.html
59+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-replication.html
5860
- name: mget
5961
x-displayName: Document - Multi get
6062
- name: mtermvectors
@@ -71,14 +73,14 @@ actions:
7173
description: >
7274
Event Query Language (EQL) is a query language for event-based time series data, such as logs, metrics, and traces.
7375
externalDocs:
74-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html
76+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/eql.html
7577
description: EQL search
7678
- name: esql
7779
x-displayName: ES|QL
7880
description: >
7981
The Elasticsearch Query Language (ES|QL) provides a powerful way to filter, transform, and analyze data stored in Elasticsearch, and in the future in other runtimes.
8082
externalDocs:
81-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html
83+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/esql.html
8284
description: ES|QL overview and tutorials
8385
# F
8486
- name: features
@@ -92,19 +94,17 @@ actions:
9294
description: >
9395
The graph explore API enables you to extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
9496
externalDocs:
95-
url: https://www.elastic.co/guide/en/kibana/current/xpack-graph.html
97+
url: https://www.elastic.co/guide/en/kibana/8.16/xpack-graph.html
9698
description: Getting started with Graph
9799
# I
98100
- name: indices
99101
x-displayName: Index
100102
description: >
101103
Index APIs enable you to manage individual indices, index settings, aliases, mappings, and index templates.
102-
- name: dangling_indices
103-
x-displayName: Index - Import dangling index
104104
- name: ilm
105105
x-displayName: Index lifecycle management
106106
externalDocs:
107-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management.html
107+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/index-lifecycle-management.html
108108
description: Manage the index lifecycle
109109
- name: inference
110110
x-displayName: Inference
@@ -126,7 +126,7 @@ actions:
126126
description: >
127127
Logstash APIs enable you to manage pipelines that are used by Logstash Central Management.
128128
externalDocs:
129-
url: https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html
129+
url: https://www.elastic.co/guide/en/logstash/8.16/logstash-centralized-pipeline-management.html
130130
description: Centralized pipeline management
131131
# M
132132
- name: ml
@@ -135,19 +135,19 @@ actions:
135135
x-displayName: Machine learning anomaly detection
136136
# description:
137137
externalDocs:
138-
url: https://www.elastic.co/guide/en/machine-learning/current/ml-ad-finding-anomalies.html
138+
url: https://www.elastic.co/guide/en/machine-learning/8.16/ml-ad-finding-anomalies.html
139139
description: Finding anomalies
140140
- name: ml data frame
141141
x-displayName: Machine learning data frame analytics
142142
# description:
143143
externalDocs:
144-
url: https://www.elastic.co/guide/en/machine-learning/current/ml-dfa-overview.html
144+
url: https://www.elastic.co/guide/en/machine-learning/8.16/ml-dfa-overview.html
145145
description: Data frame analytics overview
146146
- name: ml trained model
147147
x-displayName: Machine learning trained model
148148
# description:
149149
externalDocs:
150-
url: https://www.elastic.co/guide/en/machine-learning/current/ml-nlp-overview.html
150+
url: https://www.elastic.co/guide/en/machine-learning/8.16/ml-nlp-overview.html
151151
description: Natural language processing overview
152152
- name: migration
153153
x-displayName: Migration
@@ -167,26 +167,16 @@ actions:
167167
If a query matches one or more rules in the ruleset, the query is re-written to apply the rules before searching.
168168
This allows pinning documents for only queries that match a specific term.
169169
externalDocs:
170-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rule-query.html
170+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl-rule-query.html
171171
description: Rule query
172172
# R
173173
- name: rollup
174174
x-displayName: Rollup
175175
# S
176176
- name: script
177177
x-displayName: Script
178-
- name: get_script_context
179-
x-displayName: Script - Get contexts
180-
- name: get_script_languages
181-
x-displayName: Script - Get languages
182178
- name: search
183179
x-displayName: Search
184-
- name: msearch
185-
x-displayName: Search - Multi search
186-
- name: scroll
187-
x-displayName: Search - Scroll
188-
- name: terms_enum
189-
x-displayName: Search - Terms enum
190180
- name: search_application
191181
x-displayName: Search application
192182
- name: searchable_snapshots
@@ -198,21 +188,21 @@ actions:
198188
description: >
199189
Snapshot and restore APIs enable you to set up snapshot repositories, manage snapshot backups, and restore snapshots to a running cluster.
200190
externalDocs:
201-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html
191+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/snapshot-restore.html
202192
description: Snapshot and restore
203193
- name: slm
204194
x-displayName: Snapshot lifecycle management
205195
description: >
206196
Snapshot lifecycle management (SLM) APIs enable you to set up policies to automatically take snapshots and control how long they are retained.
207197
externalDocs:
208-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html
198+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/snapshots-take-snapshot.html
209199
description: Create a snapshot
210200
- name: sql
211201
x-displayName: SQL
212202
description: >
213203
Elasticsearch's SQL APIs enable you to run SQL queries on Elasticsearch indices and data streams.
214204
externalDocs:
215-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-sql.html
205+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/xpack-sql.html
216206
description: An overview and tutorials for the Elasticsearch SQL features
217207
- name: synonyms
218208
x-displayName: Synonyms
@@ -248,7 +238,7 @@ actions:
248238
description: >
249239
Character filters that are used to preprocess characters before they are passed to the tokenizer.
250240
externalDocs:
251-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html
241+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-charfilters.html
252242
description: Character filters reference
253243
- target: "$.components['schemas']['_types.analysis:Tokenizer'].oneOf"
254244
description: Remove existing oneOf definition for tokenizer
@@ -260,7 +250,7 @@ actions:
260250
description: >
261251
A tokenizer to use to convert text into tokens.
262252
externalDocs:
263-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html
253+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-tokenizers.html
264254
description: Tokenizer reference
265255
- target: "$.components['schemas']['_types.analysis:TokenFilter'].oneOf"
266256
description: Remove existing oneOf definition for tokenfilter
@@ -272,15 +262,15 @@ actions:
272262
description: >
273263
Token filters that are applied after the tokenizer.
274264
externalDocs:
275-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html
265+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-tokenfilters.html
276266
description: Token filter reference
277267
- target: "$.components['schemas']['security._types:RoleTemplateScript']"
278268
description: Add x-model where recommended by Bump.sh
279269
update:
280270
x-model: true
281271
externalDocs:
282272
description: Templating a role query
283-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html#templating-role-query
273+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/field-and-document-access-control.html#templating-role-query
284274
# Abbreviate and annotate items that are not shown in Bump.sh due to depth limits
285275
- target: "$.components['schemas']['ml._types:Datafeed'].properties.query"
286276
description: Remove query object from anomaly detection datafeed
@@ -297,7 +287,7 @@ actions:
297287
All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
298288
By default, this property has the following value: `{"match_all": {"boost": 1}}`.
299289
externalDocs:
300-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
290+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl.html
301291
description: Query DSL
302292
- target: "$.components['schemas']['ml._types:CategorizationAnalyzerDefinition'].properties.tokenizer"
303293
description: Remove tokenizer object from ML anomaly detection analysis config
@@ -318,7 +308,7 @@ actions:
318308
Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2).
319309
`ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify `"tokenizer": "ml_classic"` in your `categorization_analyzer`.
320310
externalDocs:
321-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html
311+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-tokenizers.html
322312
description: Tokenizer reference
323313
- target: "$.components['schemas']['ml._types:DataframeAnalyticsSource'].properties.query"
324314
description: Remove query object from data frame analytics source
@@ -335,7 +325,7 @@ actions:
335325
All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
336326
By default, this property has the following value: `{"match_all": {}}`.
337327
externalDocs:
338-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
328+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl.html
339329
description: Query DSL
340330
- target: "$.components['schemas']['transform._types:Source'].properties.query"
341331
description: Remove query object from transform source
@@ -349,8 +339,19 @@ actions:
349339
description: >
350340
A query clause that retrieves a subset of data from the source index.
351341
externalDocs:
352-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
342+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl.html
353343
description: Query DSL
344+
- target: "$.components['schemas']['_global.search._types:FieldCollapse']"
345+
description: Add x-model and externalDocs
346+
update:
347+
x-model: true
348+
externalDocs:
349+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/collapse-search-results.html
350+
- target: "$.components['schemas']['_global.msearch:MultisearchBody'].properties"
351+
description: Add x-model
352+
update:
353+
aggregations:
354+
x-model: true
354355
# Examples
355356
- target: "$.components['requestBodies']['async_search.submit']"
356357
description: "Add example for asynch search submit request"

0 commit comments

Comments
 (0)