Skip to content

Commit f0652e2

Browse files
committed
[DOCS] Release notes for 8.17.0
1 parent f2eecfa commit f0652e2

File tree

3 files changed

+36
-0
lines changed

3 files changed

+36
-0
lines changed

CHANGELOG.md

+14
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
*See the full release notes on the official documentation website: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/release_notes.html*
22

3+
## 8.17.0 Release notes
4+
5+
### Client
6+
* Tested versions of Ruby for 8.17.0: Ruby (MRI) 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4.
7+
8+
### API
9+
10+
#### API changes
11+
* `async_search.submit` - Removes `keep_alive` parameter. Adds:
12+
* `ccs_minimize_roundtrips` (Boolean): When doing a cross-cluster search, setting it to true may improve overall search latency, particularly when searching clusters with a large number of shards. However, when set to true, the progress of searches on the remote clusters will not be received until the search finishes on all clusters.
13+
* `rest_total_hits_as_int` (Boolean): Indicates whether hits.total should be rendered as an integer or an object in the rest search response.
14+
* `open_point_in_time` - Adds `allow_partial_search_results` (Boolean) parameter: Specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception (default: false).
15+
16+
317
## 8.16.0 Release notes
418

519
### Client

docs/release_notes/817.asciidoc

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
[[release_notes_8_17]]
2+
=== 8.17 Release notes
3+
4+
[discrete]
5+
[[release_notes_8_17_0]]
6+
=== 8.17.0 Release notes
7+
8+
[discrete]
9+
==== Client
10+
* Tested versions of Ruby for 8.17.0: Ruby (MRI) 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4.
11+
12+
[discrete]
13+
==== API
14+
15+
[discrete]
16+
===== API changes
17+
* `async_search.submit` - Removes `keep_alive` parameter. Adds:
18+
** `ccs_minimize_roundtrips` (Boolean): When doing a cross-cluster search, setting it to true may improve overall search latency, particularly when searching clusters with a large number of shards. However, when set to true, the progress of searches on the remote clusters will not be received until the search finishes on all clusters.
19+
** `rest_total_hits_as_int` (Boolean): Indicates whether hits.total should be rendered as an integer or an object in the rest search response.
20+
* `open_point_in_time` - Adds `allow_partial_search_results` (Boolean) parameter: Specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception (default: false).

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_8_17, 8.17 Release Notes>>
67
* <<release_notes_8_16, 8.16 Release Notes>>
78
* <<release_notes_8_15, 8.15 Release Notes>>
89
* <<release_notes_8_14, 8.14 Release Notes>>
@@ -38,6 +39,7 @@
3839
* <<release_notes_75, 7.5 Release Notes>>
3940
* <<release_notes_70, 7.0 Release Notes>>
4041

42+
include::817.asciidoc[]
4143
include::816.asciidoc[]
4244
include::815.asciidoc[]
4345
include::814.asciidoc[]

0 commit comments

Comments
 (0)