Skip to content

Commit f97e83f

Browse files
committed
[DOCS] Adds 8.4 Release notes
1 parent 2548384 commit f97e83f

File tree

3 files changed

+58
-0
lines changed

3 files changed

+58
-0
lines changed

CHANGELOG.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,30 @@
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.4.0 Release Notes
4+
5+
- Tested versions of Ruby for 8.4.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3.
6+
7+
### API
8+
9+
#### New APIs
10+
11+
* `security.update_api_key` - Updates attributes of an existing API key. [Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.4/security-api-update-api-key.html).
12+
13+
#### API Changes
14+
15+
* `get` - Adds new parameter `force_synthetic_source` (Boolean) Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.
16+
* `machine_learning.start_trained_model_deployment` - Adds new parameter `cache_size` (String) A byte-size value for configuring the inference cache size. For example, 20mb.
17+
* `mget` - Adds new parameter `force_synthetic_source` (Boolean) Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.
18+
* `search` - Adds new parameter `force_synthetic_source` (Boolean) Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.
19+
* `snapshot.get` - Adds new parameters:
20+
* `sort` (String) Allows setting a sort order for the result. Defaults to start_time (options: start_time, duration, name, repository, index_count, shard_count, failed_shard_count).
21+
* `size` (Integer) Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit.
22+
* `order` (String) Sort order (options: asc, desc).
23+
* `from_sort_value` (String) Value of the current sort column at which to start retrieval.
24+
* `after` (String) Offset identifier to start pagination from as returned by the 'next' field in the response body.
25+
* `offset` (Integer) Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0.
26+
* `slm_policy_filter` (String) Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Accepts wildcards. Use the special pattern '_none' to match snapshots without an SLM policy.
27+
328
## 8.3.0 Release Notes
429

530
- Tested versions of Ruby for 8.3.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3.

docs/release_notes/84.asciidoc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
[[release_notes_84]]
2+
=== 8.4 Release notes
3+
4+
[discrete]
5+
[[release_notes_840]]
6+
=== 8.4.0 Release notes
7+
8+
- Tested versions of Ruby for 8.4.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3.
9+
10+
[discrete]
11+
==== API
12+
13+
[discrete]
14+
===== New APIs
15+
16+
* `security.update_api_key` - Updates attributes of an existing API key. https://www.elastic.co/guide/en/elasticsearch/reference/8.4/security-api-update-api-key.html[Documentation].
17+
18+
[discrete]
19+
===== API Changes
20+
* `get` - Adds new parameter `force_synthetic_source` (Boolean) Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.
21+
* `machine_learning.start_trained_model_deployment` - Adds new parameter `cache_size` (String) A byte-size value for configuring the inference cache size. For example, 20mb.
22+
* `mget` - Adds new parameter `force_synthetic_source` (Boolean) Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.
23+
* `search` - Adds new parameter `force_synthetic_source` (Boolean) Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.
24+
* `snapshot.get` - Adds new parameters:
25+
** `sort` (String) Allows setting a sort order for the result. Defaults to start_time (options: start_time, duration, name, repository, index_count, shard_count, failed_shard_count).
26+
** `size` (Integer) Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit.
27+
** `order` (String) Sort order (options: asc, desc).
28+
** `from_sort_value` (String) Value of the current sort column at which to start retrieval.
29+
** `after` (String) Offset identifier to start pagination from as returned by the 'next' field in the response body.
30+
** `offset` (Integer) Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0.
31+
** `slm_policy_filter` (String) Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Accepts wildcards. Use the special pattern '_none' to match snapshots without an SLM policy.

docs/release_notes/index.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
[discrete]
55
=== 8.x
6+
* <<release_notes_84, 8.4 Release Notes>>
67
* <<release_notes_83, 8.3 Release Notes>>
78
* <<release_notes_82, 8.2 Release Notes>>
89
* <<release_notes_81, 8.1 Release Notes>>
@@ -25,6 +26,7 @@
2526
* <<release_notes_75, 7.5 Release Notes>>
2627
* <<release_notes_70, 7.0 Release Notes>>
2728

29+
include::84.asciidoc[]
2830
include::83.asciidoc[]
2931
include::82.asciidoc[]
3032
include::81.asciidoc[]

0 commit comments

Comments
 (0)