Skip to content

Commit dba53bb

Browse files
committed
[DOCS] Adds Release Notes for 8.1
1 parent a64a794 commit dba53bb

File tree

3 files changed

+71
-0
lines changed

3 files changed

+71
-0
lines changed

CHANGELOG.md

+33
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,38 @@
11
*To see release notes for the `7.x` branch and older releases, see [CHANGELOG on the 7.17 branch](https://github.com/elastic/elasticsearch-ruby/blob/7.17/CHANGELOG.md).*
22

3+
## 8.1.0
4+
5+
- Tested versions of Ruby for 8.1.0: Ruby (MRI) 2.6, 2.7, 3.0 and 3.1, JRuby 9.3.
6+
7+
### API
8+
9+
Updated for compatibility with Elasticsearch 8.1's API.
10+
11+
#### New parameters:
12+
- `indices.forcemerge` - `wait_for_completion` Should the request wait until the force merge is completed.
13+
- `indices.get` - `features` Return only information on specified index features (options: aliases, mappings, settings).
14+
- `ingest.put_pipeline` `if_version` (Integer), required version for optimistic concurrency control for pipeline updates.
15+
- `ml.delete_trained_model` - `timeout` controls the amount of time to wait for the model to be deleted. `force` (Boolean) true if the model should be forcefully deleted.
16+
- `ml.stop_trained_model_deployment` - `allow_no_match` whether to ignore if a wildcard expression matches no deployments. (This includes `_all` string or when no deployments have been specified). `force` true if the deployment should be forcefully stopped. Adds `body` parameter, the stop deployment parameters.
17+
- `nodes.hot_threads` - `sort` the sort order for 'cpu' type (default: total) (options: cpu, total)
18+
19+
#### Updated parameters:
20+
- `indices.get_index_template` - `name` is now a String, a pattern that returned template names must match.
21+
- `knn_search` - `index` removes option to use empty string to perform the operation on all indices.
22+
- `ml.close_job`, `ml.get_job_stats`, `ml.get_jobs`, `ml.get_overall_buckets` - Remove `allow_no_jobs` parameter.
23+
- `ml.get_datafeed_stats`, `ml.get_datafeeds` - Remove `allow_no_datafeeds` parameter.
24+
- `nodes.hot_threads` - `type` parameter adds `mem` option.
25+
- `nodes.info` - `metric` updated to use `_all` to retrieve all metrics and `_none` to retrieve the node identity without any additional metrics. (options: settings, os, process, jvm, thread_pool, transport, http, plugins, ingest, indices, aggregations, _all, _none). `index_metric` option `shards` changes to `shard_stats`.
26+
- `open_point_in_time` - `keep_alive` is now a required parameter.
27+
- `search_mvt` - `grid_type` parameter adds `centroid` option in addition to `grid` and `point`.
28+
29+
- New experimental APIs, designed for internal use by the fleet server project: `fleet.search`, `fleet.msearch`.
30+
31+
#### New APIs
32+
- OpenID Connect Authentication: `security.oidc_authenticate`, `security.oidc_logout`, `security.oidc_prepare_authentication`.
33+
- `transform.reset_transform`.
34+
35+
336
## 8.0.0
437

538
First release for the `8.x` branch with a few major changes.

docs/release_notes/81.asciidoc

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
[[release_notes_81]]
2+
=== 8.1 Release notes
3+
4+
- Tested versions of Ruby for 8.1.0: Ruby (MRI) 2.6, 2.7, 3.0 and 3.1, JRuby 9.3.
5+
6+
[discrete]
7+
==== API
8+
9+
Updated for compatibility with Elasticsearch 8.1's API.
10+
11+
[discrete]
12+
===== New parameters:
13+
- `indices.forcemerge` - `wait_for_completion` Should the request wait until the force merge is completed.
14+
- `indices.get` - `features` Return only information on specified index features (options: aliases, mappings, settings).
15+
- `ingest.put_pipeline` `if_version` (Integer), required version for optimistic concurrency control for pipeline updates.
16+
- `ml.delete_trained_model` - `timeout` controls the amount of time to wait for the model to be deleted. `force` (Boolean) true if the model should be forcefully deleted.
17+
- `ml.stop_trained_model_deployment` - `allow_no_match` whether to ignore if a wildcard expression matches no deployments. (This includes `_all` string or when no deployments have been specified). `force` true if the deployment should be forcefully stopped. Adds `body` parameter, the stop deployment parameters.
18+
- `nodes.hot_threads` - `sort` the sort order for 'cpu' type (default: total) (options: cpu, total)
19+
20+
[discrete]
21+
===== Updated parameters:
22+
- `indices.get_index_template` - `name` is now a String, a pattern that returned template names must match.
23+
- `knn_search` - `index` removes option to use empty string to perform the operation on all indices.
24+
- `ml.close_job`, `ml.get_job_stats`, `ml.get_jobs`, `ml.get_overall_buckets` - Remove `allow_no_jobs` parameter.
25+
- `ml.get_datafeed_stats`, `ml.get_datafeeds` - Remove `allow_no_datafeeds` parameter.
26+
- `nodes.hot_threads` - `type` parameter adds `mem` option.
27+
- `nodes.info` - `metric` updated to use `_all` to retrieve all metrics and `_none` to retrieve the node identity without any additional metrics. (options: settings, os, process, jvm, thread_pool, transport, http, plugins, ingest, indices, aggregations, _all, _none). `index_metric` option `shards` changes to `shard_stats`.
28+
- `open_point_in_time` - `keep_alive` is now a required parameter.
29+
- `search_mvt` - `grid_type` parameter adds `centroid` option in addition to `grid` and `point`.
30+
31+
- New experimental APIs, designed for internal use by the fleet server project: `fleet.search`, `fleet.msearch`.
32+
33+
[discrete]
34+
===== New APIs
35+
- OpenID Connect Authentication: `security.oidc_authenticate`, `security.oidc_logout`, `security.oidc_prepare_authentication`.
36+
- `transform.reset_transform`.

docs/release_notes/index.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
[discrete]
55
=== 8.x
6+
* <<release_notes_81, 8.1 Release Notes>>
67
* <<release_notes_80, 8.0 Release Notes>>
78

89
[discrete]
@@ -22,6 +23,7 @@
2223
* <<release_notes_75, 7.5 Release Notes>>
2324
* <<release_notes_70, 7.0 Release Notes>>
2425

26+
include::81.asciidoc[]
2527
include::80.asciidoc[]
2628
include::717.asciidoc[]
2729
include::716.asciidoc[]

0 commit comments

Comments
 (0)