Skip to content

Commit 8fe272f

Browse files
authored
Merge branch '8.16' into backport-3055-to-8.16
2 parents fce97bd + 4659b3e commit 8fe272f

File tree

39 files changed

+538
-328
lines changed

39 files changed

+538
-328
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 & 36 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,7 +94,7 @@ 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
@@ -102,7 +104,7 @@ actions:
102104
- name: ilm
103105
x-displayName: Index lifecycle management
104106
externalDocs:
105-
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
106108
description: Manage the index lifecycle
107109
- name: inference
108110
x-displayName: Inference
@@ -124,7 +126,7 @@ actions:
124126
description: >
125127
Logstash APIs enable you to manage pipelines that are used by Logstash Central Management.
126128
externalDocs:
127-
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
128130
description: Centralized pipeline management
129131
# M
130132
- name: ml
@@ -133,19 +135,19 @@ actions:
133135
x-displayName: Machine learning anomaly detection
134136
# description:
135137
externalDocs:
136-
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
137139
description: Finding anomalies
138140
- name: ml data frame
139141
x-displayName: Machine learning data frame analytics
140142
# description:
141143
externalDocs:
142-
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
143145
description: Data frame analytics overview
144146
- name: ml trained model
145147
x-displayName: Machine learning trained model
146148
# description:
147149
externalDocs:
148-
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
149151
description: Natural language processing overview
150152
- name: migration
151153
x-displayName: Migration
@@ -165,26 +167,16 @@ actions:
165167
If a query matches one or more rules in the ruleset, the query is re-written to apply the rules before searching.
166168
This allows pinning documents for only queries that match a specific term.
167169
externalDocs:
168-
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
169171
description: Rule query
170172
# R
171173
- name: rollup
172174
x-displayName: Rollup
173175
# S
174176
- name: script
175177
x-displayName: Script
176-
- name: get_script_context
177-
x-displayName: Script - Get contexts
178-
- name: get_script_languages
179-
x-displayName: Script - Get languages
180178
- name: search
181179
x-displayName: Search
182-
- name: msearch
183-
x-displayName: Search - Multi search
184-
- name: scroll
185-
x-displayName: Search - Scroll
186-
- name: terms_enum
187-
x-displayName: Search - Terms enum
188180
- name: search_application
189181
x-displayName: Search application
190182
- name: searchable_snapshots
@@ -198,21 +190,21 @@ actions:
198190
description: >
199191
Snapshot and restore APIs enable you to set up snapshot repositories, manage snapshot backups, and restore snapshots to a running cluster.
200192
externalDocs:
201-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html
193+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/snapshot-restore.html
202194
description: Snapshot and restore
203195
- name: slm
204196
x-displayName: Snapshot lifecycle management
205197
description: >
206198
Snapshot lifecycle management (SLM) APIs enable you to set up policies to automatically take snapshots and control how long they are retained.
207199
externalDocs:
208-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html
200+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/snapshots-take-snapshot.html
209201
description: Create a snapshot
210202
- name: sql
211203
x-displayName: SQL
212204
description: >
213205
Elasticsearch's SQL APIs enable you to run SQL queries on Elasticsearch indices and data streams.
214206
externalDocs:
215-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-sql.html
207+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/xpack-sql.html
216208
description: An overview and tutorials for the Elasticsearch SQL features
217209
- name: synonyms
218210
x-displayName: Synonyms
@@ -248,7 +240,7 @@ actions:
248240
description: >
249241
Character filters that are used to preprocess characters before they are passed to the tokenizer.
250242
externalDocs:
251-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html
243+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-charfilters.html
252244
description: Character filters reference
253245
- target: "$.components['schemas']['_types.analysis:Tokenizer'].oneOf"
254246
description: Remove existing oneOf definition for tokenizer
@@ -260,7 +252,7 @@ actions:
260252
description: >
261253
A tokenizer to use to convert text into tokens.
262254
externalDocs:
263-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html
255+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-tokenizers.html
264256
description: Tokenizer reference
265257
- target: "$.components['schemas']['_types.analysis:TokenFilter'].oneOf"
266258
description: Remove existing oneOf definition for tokenfilter
@@ -272,15 +264,15 @@ actions:
272264
description: >
273265
Token filters that are applied after the tokenizer.
274266
externalDocs:
275-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html
267+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-tokenfilters.html
276268
description: Token filter reference
277269
- target: "$.components['schemas']['security._types:RoleTemplateScript']"
278270
description: Add x-model where recommended by Bump.sh
279271
update:
280272
x-model: true
281273
externalDocs:
282274
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
275+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/field-and-document-access-control.html#templating-role-query
284276
# Abbreviate and annotate items that are not shown in Bump.sh due to depth limits
285277
- target: "$.components['schemas']['ml._types:Datafeed'].properties.query"
286278
description: Remove query object from anomaly detection datafeed
@@ -297,7 +289,7 @@ actions:
297289
All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
298290
By default, this property has the following value: `{"match_all": {"boost": 1}}`.
299291
externalDocs:
300-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
292+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl.html
301293
description: Query DSL
302294
- target: "$.components['schemas']['ml._types:CategorizationAnalyzerDefinition'].properties.tokenizer"
303295
description: Remove tokenizer object from ML anomaly detection analysis config
@@ -318,7 +310,7 @@ actions:
318310
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).
319311
`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`.
320312
externalDocs:
321-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html
313+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-tokenizers.html
322314
description: Tokenizer reference
323315
- target: "$.components['schemas']['ml._types:DataframeAnalyticsSource'].properties.query"
324316
description: Remove query object from data frame analytics source
@@ -335,7 +327,7 @@ actions:
335327
All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
336328
By default, this property has the following value: `{"match_all": {}}`.
337329
externalDocs:
338-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
330+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl.html
339331
description: Query DSL
340332
- target: "$.components['schemas']['transform._types:Source'].properties.query"
341333
description: Remove query object from transform source
@@ -349,8 +341,19 @@ actions:
349341
description: >
350342
A query clause that retrieves a subset of data from the source index.
351343
externalDocs:
352-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
344+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl.html
353345
description: Query DSL
346+
- target: "$.components['schemas']['_global.search._types:FieldCollapse']"
347+
description: Add x-model and externalDocs
348+
update:
349+
x-model: true
350+
externalDocs:
351+
url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/collapse-search-results.html
352+
- target: "$.components['schemas']['_global.msearch:MultisearchBody'].properties"
353+
description: Add x-model
354+
update:
355+
aggregations:
356+
x-model: true
354357
# Examples
355358
- target: "$.components['requestBodies']['async_search.submit']"
356359
description: "Add example for asynch search submit request"

0 commit comments

Comments
 (0)