From f0652e2b669aa466efa2e220967b1d94cec9220b Mon Sep 17 00:00:00 2001 From: Fernando Briano Date: Wed, 11 Dec 2024 10:12:35 +0000 Subject: [PATCH] [DOCS] Release notes for 8.17.0 --- CHANGELOG.md | 14 ++++++++++++++ docs/release_notes/817.asciidoc | 20 ++++++++++++++++++++ docs/release_notes/index.asciidoc | 2 ++ 3 files changed, 36 insertions(+) create mode 100644 docs/release_notes/817.asciidoc diff --git a/CHANGELOG.md b/CHANGELOG.md index 3221bc74d..ac3416994 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/docs/release_notes/817.asciidoc b/docs/release_notes/817.asciidoc new file mode 100644 index 000000000..2963eeb0d --- /dev/null +++ b/docs/release_notes/817.asciidoc @@ -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). diff --git a/docs/release_notes/index.asciidoc b/docs/release_notes/index.asciidoc index b79a9bedf..47c311cd1 100644 --- a/docs/release_notes/index.asciidoc +++ b/docs/release_notes/index.asciidoc @@ -3,6 +3,7 @@ [discrete] === 8.x +* <> * <> * <> * <> @@ -38,6 +39,7 @@ * <> * <> +include::817.asciidoc[] include::816.asciidoc[] include::815.asciidoc[] include::814.asciidoc[]