Skip to content

Commit

Permalink
[DOCS] Release notes for 8.17.0
Browse files Browse the repository at this point in the history
  • Loading branch information
picandocodigo committed Dec 11, 2024
1 parent f2eecfa commit 157ae03
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
*See the full release notes on the official documentation website: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/release_notes.html*

## 8.17.0 Release notes

### Client
* Tested versions of Ruby for 8.17.0: Ruby (MRI) 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4.

### API

#### API changes
* `async_search.submit` - Removes `keep_alive` parameter. Adds:
* `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.
* `rest_total_hits_as_int` (Boolean): Indicates whether hits.total should be rendered as an integer or an object in the rest search response.
* `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).


## 8.16.0 Release notes

### Client
Expand Down
20 changes: 20 additions & 0 deletions docs/release_notes/817.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[[release_notes_8_17]]
=== 8.17 Release notes

[discrete]
[[release_notes_8_17_0]]
=== 8.17.0 Release notes

[discrete]
==== Client
* Tested versions of Ruby for 8.17.0: Ruby (MRI) 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4.

[discrete]
==== API

[discrete]
===== API changes
* `async_search.submit` - Removes `keep_alive` parameter. Adds:
** `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.
** `rest_total_hits_as_int` (Boolean): Indicates whether hits.total should be rendered as an integer or an object in the rest search response.
* `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).
1 change: 1 addition & 0 deletions docs/release_notes/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

[discrete]
=== 8.x
* <<release_notes_8_17, 8.17 Release Notes>>
* <<release_notes_8_16, 8.16 Release Notes>>
* <<release_notes_8_15, 8.15 Release Notes>>
* <<release_notes_8_14, 8.14 Release Notes>>
Expand Down

0 comments on commit 157ae03

Please sign in to comment.