Skip to content

Commit 240257e

Browse files
picandocodigopicandocodigo
committed
[DOCS] Release notes for 8.17.0 and 8.16.0
1 parent c6b5583 commit 240257e

File tree

4 files changed

+149
-0
lines changed

4 files changed

+149
-0
lines changed

‎CHANGELOG.md

+67
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,72 @@
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+
17+
## 8.16.0 Release notes
18+
19+
### Client
20+
* Tested versions of Ruby for 8.16.0: Ruby (MRI) 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4.
21+
22+
### API
23+
24+
#### API changes
25+
26+
* `capabilities` - Adds `local_only` boolean parameter: True if only the node being called should be considered.
27+
* `cluster.stats`- Removes `flat_settings` parameter, adds `include_remotes` boolean parameter: Include remote cluster data into the response (default: false)
28+
* `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).
29+
* `query_rules.delete_ruleset` - Accepts `ignore: 404` common parameter.
30+
31+
##### Timeout parameters:
32+
33+
These parameters have been added to several APIs:
34+
35+
* `master_timeout` timeout for processing on master node.
36+
* `timeout` timeout for acknowledgement of update from all nodes in cluster parameters.
37+
38+
Added in:
39+
40+
* `indices.create_data_stream` - both.
41+
* `indices.delete_data_stream` - `master_timeout`.
42+
* `indices.get_data_lifecycle` - `master_timeout`.
43+
* `indices.get_data_stream` - `master_timeout`.
44+
* `indices.migrate_to_data_stream` - both.
45+
* `indices.promote_data_stream` - `master_timeout`.
46+
* `search_shards` - `master_timeout`.
47+
48+
#### APIs Promoted from Experimental to Stable:
49+
50+
* `indices.delete_data_lifecycle`
51+
* `indices.explain_data_lifecycle`
52+
* `indices.get_data_lifecycle`
53+
* `indices.put_data_lifecycle`
54+
* `security.create_cross_cluster_api_key`
55+
* `security.update_cross_cluster_api_key`
56+
57+
#### New APIs
58+
59+
* `ingest.delete_ip_location_database` - Deletes an ip location database configuration.
60+
* `ingest.get_ip_location_database` - Returns the specified ip location database configuration.
61+
* `ingest.put_ip_location_database` - Puts the configuration for a ip location database to be downloaded.
62+
63+
64+
#### New Experimental APIs
65+
66+
* `inference.stream_inference` - Perform streaming inference.
67+
* `query_rules.test` - Tests a query ruleset to identify the rules that would match input criteria.
68+
69+
370
## 8.15.0 Release notes
471

572
### Client

‎docs/release_notes/816.asciidoc

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
[[release_notes_8_16]]
2+
=== 8.16 Release notes
3+
4+
[discrete]
5+
[[release_notes_8_16_0]]
6+
=== 8.16.0 Release notes
7+
8+
[discrete]
9+
==== Client
10+
* Tested versions of Ruby for 8.16.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+
18+
* `capabilities` - Adds `local_only` boolean parameter: True if only the node being called should be considered.
19+
* `cluster.stats`- Removes `flat_settings` parameter, adds `include_remotes` boolean parameter: Include remote cluster data into the response (default: false).
20+
* `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).
21+
* `query_rules.delete_ruleset` - Accepts `ignore: 404` common parameter.
22+
23+
These parameters have been added to several APIs:
24+
25+
* `master_timeout` timeout for processing on master node.
26+
* `timeout` timeout for acknowledgement of update from all nodes in cluster parameters.
27+
28+
Added in:
29+
30+
* `indices.create_data_stream` - both.
31+
* `indices.delete_data_stream` - `master_timeout`.
32+
* `indices.get_data_lifecycle` - `master_timeout`.
33+
* `indices.get_data_stream` - `master_timeout`.
34+
* `indices.migrate_to_data_stream` - both.
35+
* `indices.promote_data_stream` - `master_timeout`.
36+
* `search_shards` - `master_timeout`.
37+
38+
**APIs Promoted from Experimental to Stable:**
39+
40+
* `indices.delete_data_lifecycle`
41+
* `indices.explain_data_lifecycle`
42+
* `indices.get_data_lifecycle`
43+
* `indices.put_data_lifecycle`
44+
* `security.create_cross_cluster_api_key`
45+
* `security.update_cross_cluster_api_key`
46+
47+
**New APIs**
48+
49+
* `ingest.delete_ip_location_database` - Deletes an ip location database configuration.
50+
* `ingest.get_ip_location_database` - Returns the specified ip location database configuration.
51+
* `ingest.put_ip_location_database` - Puts the configuration for a ip location database to be downloaded.
52+
53+
54+
**New Experimental APIs**
55+
56+
* `inference.stream_inference` - Perform streaming inference.
57+
* `query_rules.test` - Tests a query ruleset to identify the rules that would match input criteria.

‎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

+5
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33

44
[discrete]
55
=== 8.x
6+
7+
* <<release_notes_8_17, 8.17 Release Notes>>
8+
* <<release_notes_8_16, 8.16 Release Notes>>
69
* <<release_notes_8_15, 8.15 Release Notes>>
710
* <<release_notes_8_14, 8.14 Release Notes>>
811
* <<release_notes_8_13, 8.13 Release Notes>>
@@ -37,6 +40,8 @@
3740
* <<release_notes_75, 7.5 Release Notes>>
3841
* <<release_notes_70, 7.0 Release Notes>>
3942

43+
include::817.asciidoc[]
44+
include::816.asciidoc[]
4045
include::815.asciidoc[]
4146
include::814.asciidoc[]
4247
include::813.asciidoc[]

0 commit comments

Comments
 (0)