From 6e015dfb6dbf48d0456625dfd3b58c6392969b0f 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 and 8.16.0 --- CHANGELOG.md | 67 +++++++++++++++++++++++++++++++ docs/release_notes/816.asciidoc | 57 ++++++++++++++++++++++++++ docs/release_notes/817.asciidoc | 20 +++++++++ docs/release_notes/index.asciidoc | 5 +++ 4 files changed, 149 insertions(+) create mode 100644 docs/release_notes/816.asciidoc create mode 100644 docs/release_notes/817.asciidoc diff --git a/CHANGELOG.md b/CHANGELOG.md index 257dcea00..ac3416994 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,72 @@ *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 +* Tested versions of Ruby for 8.16.0: Ruby (MRI) 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4. + +### API + +#### API changes + +* `capabilities` - Adds `local_only` boolean parameter: True if only the node being called should be considered. +* `cluster.stats`- Removes `flat_settings` parameter, adds `include_remotes` boolean parameter: Include remote cluster data into the response (default: false) +* `indices.get_data_stream` - Adds `verbose` boolean parameter: Whether the maximum timestamp for each data stream should be calculated and returned (default: false). Adds `master_timeout` (see below). +* `query_rules.delete_ruleset` - Accepts `ignore: 404` common parameter. + +##### Timeout parameters: + +These parameters have been added to several APIs: + +* `master_timeout` timeout for processing on master node. +* `timeout` timeout for acknowledgement of update from all nodes in cluster parameters. + +Added in: + +* `indices.create_data_stream` - both. +* `indices.delete_data_stream` - `master_timeout`. +* `indices.get_data_lifecycle` - `master_timeout`. +* `indices.get_data_stream` - `master_timeout`. +* `indices.migrate_to_data_stream` - both. +* `indices.promote_data_stream` - `master_timeout`. +* `search_shards` - `master_timeout`. + +#### APIs Promoted from Experimental to Stable: + +* `indices.delete_data_lifecycle` +* `indices.explain_data_lifecycle` +* `indices.get_data_lifecycle` +* `indices.put_data_lifecycle` +* `security.create_cross_cluster_api_key` +* `security.update_cross_cluster_api_key` + +#### New APIs + +* `ingest.delete_ip_location_database` - Deletes an ip location database configuration. +* `ingest.get_ip_location_database` - Returns the specified ip location database configuration. +* `ingest.put_ip_location_database` - Puts the configuration for a ip location database to be downloaded. + + +#### New Experimental APIs + +* `inference.stream_inference` - Perform streaming inference. +* `query_rules.test` - Tests a query ruleset to identify the rules that would match input criteria. + + ## 8.15.0 Release notes ### Client diff --git a/docs/release_notes/816.asciidoc b/docs/release_notes/816.asciidoc new file mode 100644 index 000000000..c32e719f5 --- /dev/null +++ b/docs/release_notes/816.asciidoc @@ -0,0 +1,57 @@ +[[release_notes_8_16]] +=== 8.16 Release notes + +[discrete] +[[release_notes_8_16_0]] +=== 8.16.0 Release notes + +[discrete] +==== Client +* Tested versions of Ruby for 8.16.0: Ruby (MRI) 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4. + +[discrete] +==== API + +[discrete] +===== API changes + +* `capabilities` - Adds `local_only` boolean parameter: True if only the node being called should be considered. +* `cluster.stats`- Removes `flat_settings` parameter, adds `include_remotes` boolean parameter: Include remote cluster data into the response (default: false). +* `indices.get_data_stream` - Adds `verbose` boolean parameter: Whether the maximum timestamp for each data stream should be calculated and returned (default: false). Adds `master_timeout` (see below). +* `query_rules.delete_ruleset` - Accepts `ignore: 404` common parameter. + +These parameters have been added to several APIs: + +* `master_timeout` timeout for processing on master node. +* `timeout` timeout for acknowledgement of update from all nodes in cluster parameters. + +Added in: + +* `indices.create_data_stream` - both. +* `indices.delete_data_stream` - `master_timeout`. +* `indices.get_data_lifecycle` - `master_timeout`. +* `indices.get_data_stream` - `master_timeout`. +* `indices.migrate_to_data_stream` - both. +* `indices.promote_data_stream` - `master_timeout`. +* `search_shards` - `master_timeout`. + +**APIs Promoted from Experimental to Stable:** + +* `indices.delete_data_lifecycle` +* `indices.explain_data_lifecycle` +* `indices.get_data_lifecycle` +* `indices.put_data_lifecycle` +* `security.create_cross_cluster_api_key` +* `security.update_cross_cluster_api_key` + +**New APIs** + +* `ingest.delete_ip_location_database` - Deletes an ip location database configuration. +* `ingest.get_ip_location_database` - Returns the specified ip location database configuration. +* `ingest.put_ip_location_database` - Puts the configuration for a ip location database to be downloaded. + + +**New Experimental APIs** + +* `inference.stream_inference` - Perform streaming inference. +* `query_rules.test` - Tests a query ruleset to identify the rules that would match input criteria. 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 2c6223c83..3b2ef3578 100644 --- a/docs/release_notes/index.asciidoc +++ b/docs/release_notes/index.asciidoc @@ -3,6 +3,9 @@ [discrete] === 8.x + +* <> +* <> * <> * <> * <> @@ -37,6 +40,8 @@ * <> * <> +include::817.asciidoc[] +include::816.asciidoc[] include::815.asciidoc[] include::814.asciidoc[] include::813.asciidoc[]