Skip to content

Commit d37bf31

Browse files
picandocodigopicandocodigo
committed
[DOCS] Release notes for 8.15.0
1 parent 65ddbce commit d37bf31

File tree

3 files changed

+185
-0
lines changed

3 files changed

+185
-0
lines changed

‎CHANGELOG.md

+84
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,89 @@
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.15.0 Release notes
4+
5+
### Client
6+
* Tested versions of Ruby for 8.15.0: Ruby (MRI) 3.0, 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4.
7+
8+
#### API changes
9+
10+
* `snapshot.delete` - Adds `wait_for_completion` Boolean parameter, should this request wait until the operation has completed before returning.
11+
* `cluster.allocation_explain` - `body` is no longer a required parameter.
12+
* `connector.put` - (experimental API) `body` and `connector_id` no longer required parameters.
13+
* `machine_learning.update_trained_model_deployment` has been promoted to stable from Beta. Adds Integer parameter `number_of_allocations`, updates the model deployment to this number of allocations.
14+
15+
##### `master_timeout` and `timeout` parameters
16+
17+
These parameters have been added to several APIs:
18+
19+
* `master_timeout` timeout for processing on master node.
20+
* `timeout` timeout for acknowledgement of update from all nodes in cluster parameters.
21+
22+
The APIs:
23+
24+
* `autoscaling.delete_autoscaling_policy` - both.
25+
* `autoscaling.get_autoscaling_capacity`- `master_timeout`.
26+
* `get_autoscaling_policy` - `master_timeout`.
27+
* `put_autoscaling_policy` - both.
28+
* `enrich.delete_policy` - `master_timeout`.
29+
* `enrich.execute_policy` - `master_timeout`.
30+
* `enrich.get_policy` - `master_timeout`.
31+
* `enrich.put_policy` - `master_timeout`.
32+
* `enrich.stats` - `master_timeout`.
33+
* `features.reset_features` - `master_timeout`.
34+
* `license.delete` - both.
35+
* `license.post` - both.
36+
* `license.post_start_basic` - both.
37+
* `license.post_start_trial` - both.
38+
* `security.get_settings` - `master_timeout`.
39+
* `security.update_settings` - both.
40+
* `shutdown.get_node` - `master_timeout`.
41+
* `snapshot_lifecycle_management.start` - both.
42+
* `snapshot_lifecycle_management.stop` - both.
43+
* `watcher.get_settings` - `master_timeout`.
44+
* `watcher.start` - `master_timeout`.
45+
* `watcher.stop` - `master_timeout`.
46+
* `watcher.update_settings` - both.
47+
48+
##### Inference APIs have been renamed:
49+
50+
* `inference.delete_model` => `inference.delete`. Also adds two new parameters:
51+
* `dry_run` (Boolean), if true the endpoint will not be deleted and a list of ingest processors which reference this endpoint will be returned.
52+
* `force` (Boolean), if true the endpoint will be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields).
53+
* `inference.get_model` => `inference.get`
54+
* `inference.put_model` => `inference.put`
55+
56+
##### Query Rules parameters consolidated
57+
58+
Changes in `query_ruleset` and `query_rules` APIs, these have been combined into the `query_rules` namespace:
59+
60+
* `query_rules.delete_ruleset` - Renamed from `query_ruleset.delete`, promoted from experimental to stable.
61+
* `query_rules.delete_rule` - Deletes an individual query rule within a ruleset.
62+
* `query_rules.get_rule` - Returns the details about an individual query rule within a ruleset.
63+
* `query_rules.get_ruleset` - Renamed from `query_ruleset.get`, promoted from experimental to stable.
64+
* `query_rules.list_rulesets` - Renamed from `query_ruleset.list`, promoted from experimental to stable.
65+
* `query_rules.put_rule` - Creates or updates a query rule within a ruleset.
66+
* `query_rules.put_ruleset` - Renamed from `query_ruleset.put_ruleset`, promoted from experimental to stable.
67+
68+
#### New APIs:
69+
70+
* `ingest.delete_geoip_database` - Deletes a geoip database configuration.
71+
* `ingest.get_geoip_database` - Returns geoip database configuration.
72+
* `ingest.put_geoip_database` - Puts the configuration for a geoip database to be downloaded.
73+
* `security.bulk_delete_role` - Bulk delete roles in the native realm.
74+
* `security.bulk_put_role` - Bulk adds and updates roles in the native realm.
75+
* `security.query_role` - Retrieves information for Roles using a subset of query DSL.
76+
* `transform.get_node_stats` - Retrieves transform usage information for transform nodes.
77+
78+
#### New Experimental APIs:
79+
80+
* `connector.sync_job_claim` - Claims a connector sync job.
81+
* `connector.update_features` - Updates the connector features in the connector document.
82+
83+
### Development
84+
85+
- Added a build using [es-test-runner-ruby](https://github.com/elastic/es-test-runner-ruby) and [Elasticsearch Clients Tests](https://github.com/elastic/elasticsearch-clients-tests) which will replace the Elasticsearch YAML test runner.
86+
387
## 8.14.0 Release notes
488

589
### Client

‎docs/release_notes/815.asciidoc

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
[[release_notes_8_15]]
2+
=== 8.15 Release notes
3+
4+
[discrete]
5+
[[release_notes_8_15_0]]
6+
=== 8.15.0 Release notes
7+
8+
[discrete]
9+
==== Client
10+
* Tested versions of Ruby for 8.15.0: Ruby (MRI) 3.0, 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+
* `cluster.allocation_explain` - `body` is no longer a required parameter.
19+
* `connector.put` - (experimental API) `body` and `connector_id` are no longer required parameters.
20+
* `machine_learning.update_trained_model_deployment` has been promoted to stable from Beta. Adds Integer parameter `number_of_allocations`, updates the model deployment to this number of allocations.
21+
* `snapshot.delete` - Adds `wait_for_completion` Boolean parameter, should this request wait until the operation has completed before returning.
22+
23+
[discrete]
24+
====== `master_timeout` and `timeout` parameters
25+
26+
These parameters have been added to several APIs:
27+
28+
* `master_timeout` timeout for processing on master node.
29+
* `timeout` timeout for acknowledgement of update from all nodes in cluster parameters.
30+
31+
The APIs:
32+
33+
* `autoscaling.delete_autoscaling_policy` - both.
34+
* `autoscaling.get_autoscaling_capacity`- `master_timeout`.
35+
* `get_autoscaling_policy` - `master_timeout`.
36+
* `put_autoscaling_policy` - both.
37+
* `enrich.delete_policy` - `master_timeout`.
38+
* `enrich.execute_policy` - `master_timeout`.
39+
* `enrich.get_policy` - `master_timeout`.
40+
* `enrich.put_policy` - `master_timeout`.
41+
* `enrich.stats` - `master_timeout`.
42+
* `features.reset_features` - `master_timeout`.
43+
* `license.delete` - both.
44+
* `license.post` - both.
45+
* `license.post_start_basic` - both.
46+
* `license.post_start_trial` - both.
47+
* `security.get_settings` - `master_timeout`.
48+
* `security.update_settings` - both.
49+
* `shutdown.get_node` - `master_timeout`.
50+
* `snapshot_lifecycle_management.start` - both.
51+
* `snapshot_lifecycle_management.stop` - both.
52+
* `watcher.get_settings` - `master_timeout`.
53+
* `watcher.start` - `master_timeout`.
54+
* `watcher.stop` - `master_timeout`.
55+
* `watcher.update_settings` - both.
56+
57+
[discrete]
58+
====== Inference APIs have been renamed:
59+
60+
* `inference.delete_model` => `inference.delete`. Also adds two new parameters:
61+
** `dry_run` (Boolean), if true the endpoint will not be deleted and a list of ingest processors which reference this endpoint will be returned.
62+
** `force` (Boolean), if true the endpoint will be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields).
63+
* `inference.get_model` => `inference.get`
64+
* `inference.put_model` => `inference.put`
65+
66+
[discrete]
67+
====== Query Rules parameters consolidated
68+
69+
Changes in `query_ruleset` and `query_rules` APIs, These have been combined into the `query_rules` namespace:
70+
71+
* `query_rules.delete_ruleset` - Renamed from `query_ruleset.delete`, promoted from experimental to stable.
72+
* `query_rules.delete_rule` - Deletes an individual query rule within a ruleset.
73+
* `query_rules.get_rule` - Returns the details about an individual query rule within a ruleset.
74+
* `query_rules.get_ruleset` - Renamed from `query_ruleset.get`, promoted from experimental to stable.
75+
* `query_rules.list_rulesets` - Renamed from `query_ruleset.list`, promoted from experimental to stable.
76+
* `query_rules.put_rule` - Creates or updates a query rule within a ruleset.
77+
* `query_rules.put_ruleset` - Renamed from `query_ruleset.put_ruleset`, promoted from experimental to stable.
78+
79+
[discrete]
80+
===== New APIs:
81+
82+
* `ingest.delete_geoip_database` - Deletes a geoip database configuration.
83+
* `ingest.get_geoip_database` - Returns geoip database configuration.
84+
* `ingest.put_geoip_database` - Puts the configuration for a geoip database to be downloaded.
85+
* `security.bulk_delete_role` - Bulk delete roles in the native realm.
86+
* `security.bulk_put_role` - Bulk adds and updates roles in the native realm.
87+
* `security.query_role` - Retrieves information for Roles using a subset of query DSL.
88+
* `transform.get_node_stats` - Retrieves transform usage information for transform nodes.
89+
90+
[discrete]
91+
===== New Experimental APIs:
92+
93+
* `connector.sync_job_claim` - Claims a connector sync job.
94+
* `connector.update_features` - Updates the connector features in the connector document.
95+
96+
[discrete]
97+
==== Development
98+
99+
- Added a build using https://github.com/elastic/es-test-runner-ruby[es-test-runner-ruby] and https://github.com/elastic/elasticsearch-clients-tests[Elasticsearch Clients Tests] which will replace the Elasticsearch YAML test runner.

‎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_15, 8.15 Release Notes>>
67
* <<release_notes_8_14, 8.14 Release Notes>>
78
* <<release_notes_8_13, 8.13 Release Notes>>
89
* <<release_notes_8_12, 8.12 Release Notes>>
@@ -36,6 +37,7 @@
3637
* <<release_notes_75, 7.5 Release Notes>>
3738
* <<release_notes_70, 7.0 Release Notes>>
3839

40+
include::815.asciidoc[]
3941
include::814.asciidoc[]
4042
include::813.asciidoc[]
4143
include::812.asciidoc[]

0 commit comments

Comments
 (0)