Skip to content

Commit 8a90c01

Browse files
picandocodigopicandocodigo
committed
[DOCS] Adds 7.16 release docs
1 parent 7c24cd7 commit 8a90c01

File tree

3 files changed

+136
-0
lines changed

3 files changed

+136
-0
lines changed

‎CHANGELOG.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,69 @@
1+
## 7.16.0
2+
3+
### Client
4+
- Adds the `delay_on_retry` parameter, a value in milliseconds to wait between each failed connection, thanks [DinoPullerUqido](https://github.com/DinoPullerUqido)! [Pull Request](https://github.com/elastic/elasticsearch-ruby/pull/1521) and [backport](https://github.com/elastic/elasticsearch-ruby/pull/1523).
5+
- Adds *CA fingerprinting*. You can configure the client to only trust certificates that are signed by a specific CA certificate (CA certificate pinning) by providing a `ca_fingerprint` option. This will verify that the fingerprint of the CA certificate that has signed the certificate of the server matches the supplied value:
6+
7+
```ruby
8+
ca_fingerprint = '64F2593F...'
9+
client = Elasticsearch::Client.new(
10+
host: 'https://elastic:changeme@localhost:9200',
11+
transport_options: { ssl: { verify: false } },
12+
ca_fingerprint: ca_fingerprint
13+
)
14+
```
15+
The verification will be run once per connection.
16+
17+
- Fixes compression. When `compression` is set to `true`, the client will now gzip the request body properly and use the appropiate headers. Thanks [johnnyshields](https://github.com/johnnyshields)! [Pull Request](https://github.com/elastic/elasticsearch-ruby/pull/1478) and [backport](https://github.com/elastic/elasticsearch-ruby/pull/1526).
18+
19+
### API
20+
21+
#### Updates
22+
23+
- Cleaned up some deprecated code.
24+
- `count` - The API is documented as using `GET`, but it supports both GET and POST on the Elasticsearch side. So it was updated to only use `POST` when there's a body present, or else use `GET`. Elasticsearch would still accept a body with `GET`, but to be more semantically correct in the clients we use `POST` when there's a body.
25+
- `delete_index_template` was updated to support the `ignore_404` parameter to ignore 404 errors when attempting to delete a non-existing template.
26+
- `ingest.put_pipeline` adds new parameter `if_version`: Required version for optimistic concurrency control for pipeline updates.
27+
- `ml.put_trained_model`: adds new parameter `defer_definition_decompression`: If set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations.
28+
- `nodes.hot_threads` adds new parameter `sort`: The sort order for 'cpu' type (default: total) (options: cpu, total).
29+
- `open_point_in_time`: `keep_alive` is now a required parameter.
30+
- `search_mvt`: adds new parameter `track_total_hits`: Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.
31+
- `transform.preview_transform`: adds new parameter `transform_id`. Body is now optional and the API will use `GET` or `POST` depending on the presence of a body.
32+
33+
##### APIs promoted from experimental to stable since last version:
34+
35+
- `fleet.global_checkpoints`
36+
- `get_script_context`
37+
- `get_script_language`
38+
- `indices.resolve_index`
39+
- `monitoring.bulk`
40+
- `rank_eval`
41+
- `searchable_snapshots.mount`
42+
- `searchable_snapshots.stats`
43+
- `security.clear_cached_service_tokens`
44+
- `security.create_service_token`
45+
- `security.delete_service_token`
46+
- `security.get_service_accounts`
47+
- `security.get_service_credentials`
48+
- `shutdown.delete_node`
49+
- `shutdown.get_node`
50+
- `shutdown.put_node`
51+
- `terms_enum`
52+
53+
#### New APIs
54+
55+
- `fleet.mseach`
56+
- `fleet.search`
57+
- `indices.modify_data_stream`
58+
- `ml.infer_trained_model_deployment`
59+
- `ml.start_trained_model_deployment`
60+
- `ml.stop_trained_model_deployment`
61+
- `migration.get_feature_upgrade_status`
62+
- `migration.post_feature_upgrade_status`
63+
- `security.enroll_kibana`
64+
- `security.enroll_node`
65+
- `transform.updgrade_transforms`
66+
167
## 7.15.0
268

369
### Client

‎docs/release_notes/716.asciidoc

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
[[release_notes_716]]
2+
=== 7.16 Release notes
3+
4+
[discrete]
5+
==== Client
6+
7+
- Adds the `delay_on_retry` parameter, a value in milliseconds to wait between each failed connection, thanks https://github.com/DinoPullerUqido[DinoPullerUqido]! https://github.com/elastic/elasticsearch-ruby/pull/1521[Pull Request] and https://github.com/elastic/elasticsearch-ruby/pull/1523[backport].
8+
- Adds *CA fingerprinting*. You can configure the client to only trust certificates that are signed by a specific CA certificate (CA certificate pinning) by providing a `ca_fingerprint` option. This will verify that the fingerprint of the CA certificate that has signed the certificate of the server matches the supplied value:
9+
10+
[source,ruby]
11+
------------------------------------
12+
ca_fingerprint = '64F2593F...'
13+
client = Elasticsearch::Client.new(
14+
host: 'https://elastic:changeme@localhost:9200',
15+
transport_options: { ssl: { verify: false } },
16+
ca_fingerprint: ca_fingerprint
17+
)
18+
------------------------------------
19+
The verification will be run once per connection.
20+
21+
- Fixes compression. When `compression` is set to `true`, the client will now gzip the request body properly and use the appropiate headers. Thanks https://github.com/johnnyshields[johnnyshields]! https://github.com/elastic/elasticsearch-ruby/pull/1478[Pull Request] and https://github.com/elastic/elasticsearch-ruby/pull/1526[backport].
22+
23+
[discrete]
24+
==== API
25+
26+
- Cleaned up some deprecated code.
27+
- `count` - The API is documented as using `GET`, but it supports both GET and POST on the Elasticsearch side. So it was updated to only use `POST` when there's a body present, or else use `GET`. Elasticsearch would still accept a body with `GET`, but to be more semantically correct in the clients we use `POST` when there's a body.
28+
- `delete_index_template` was updated to support the `ignore_404` parameter to ignore 404 errors when attempting to delete a non-existing template.
29+
- `ingest.put_pipeline` adds new parameter `if_version`: Required version for optimistic concurrency control for pipeline updates.
30+
- `ml.put_trained_model`: adds new parameter `defer_definition_decompression`: If set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations.
31+
- `nodes.hot_threads` adds new parameter `sort`: The sort order for 'cpu' type (default: total) (options: cpu, total).
32+
- `open_point_in_time`: `keep_alive` is now a required parameter.
33+
- `search_mvt`: adds new parameter `track_total_hits`: Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.
34+
- `transform.preview_transform`: adds new parameter `transform_id`. Body is now optional and the API will use `GET` or `POST` depending on the presence of a body.
35+
36+
*APIs promoted from experimental to stable since last version:*
37+
38+
- `fleet.global_checkpoints`
39+
- `get_script_context`
40+
- `get_script_language`
41+
- `indices.resolve_index`
42+
- `monitoring.bulk`
43+
- `rank_eval`
44+
- `searchable_snapshots.mount`
45+
- `searchable_snapshots.stats`
46+
- `security.clear_cached_service_tokens`
47+
- `security.create_service_token`
48+
- `security.delete_service_token`
49+
- `security.get_service_accounts`
50+
- `security.get_service_credentials`
51+
- `shutdown.delete_node`
52+
- `shutdown.get_node`
53+
- `shutdown.put_node`
54+
- `terms_enum`
55+
56+
*New APIs*
57+
58+
- `fleet.mseach`
59+
- `fleet.search`
60+
- `indices.modify_data_stream`
61+
- `ml.infer_trained_model_deployment`
62+
- `ml.start_trained_model_deployment`
63+
- `ml.stop_trained_model_deployment`
64+
- `migration.get_feature_upgrade_status`
65+
- `migration.post_feature_upgrade_status`
66+
- `security.enroll_kibana`
67+
- `security.enroll_node`
68+
- `transform.updgrade_transforms`

‎docs/release_notes/index.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
[discrete]
66
=== 7.x
7+
* <<release_notes_716, 7.16 Release Notes>>
78
* <<release_notes_715, 7.15 Release Notes>>
89
* <<release_notes_714, 7.14 Release Notes>>
910
* <<release_notes_713, 7.13 Release Notes>>
@@ -17,6 +18,7 @@
1718
* <<release_notes_75, 7.5 Release Notes>>
1819
* <<release_notes_70, 7.0 Release Notes>>
1920

21+
include::716.asciidoc[]
2022
include::715.asciidoc[]
2123
include::714.asciidoc[]
2224
include::713.asciidoc[]

0 commit comments

Comments
 (0)