Skip to content

Commit

Permalink
[DOCS] Release notes 8.14
Browse files Browse the repository at this point in the history
  • Loading branch information
picandocodigo committed Jun 5, 2024
1 parent 99ebc22 commit 30925b8
Show file tree
Hide file tree
Showing 3 changed files with 100 additions and 0 deletions.
46 changes: 46 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,51 @@
*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.14.0 Release notes

### Client
* Tested versions of Ruby for 8.14.0: Ruby (MRI) 3.0, 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4.

### API

API changes:

- All Connector APIs have been migrated to one common namespace `connector`:
- `connector_secret.delete` -> `connector.secret_delete`
- `connector_secret.get` -> `connector.secret_get`
- `connector_secret.post` -> `connector.secret_post`
- `connector_secret.put` -> `connector.secret_put`
- `connector_sync_job.cancel` -> `connector.sync_job_cancel`
- `connector_sync_job.check_in` -> `connector.sync_job_check_in`
- `connector_sync_job.delete` -> `connector.sync_job_delete`
- `connector_sync_job.error` -> `connector.sync_job_error`
- `connector_sync_job.get` -> `connector.sync_job_get`
- `connector_sync_job.post` -> `connector.sync_job_post`
- `connector_sync_job.update_stats` -> `connector.sync_job_update_stats`

- `connector.delete` - Adds Boolean parameter `:delete_sync_jobs`: Determines whether associated sync jobs are also deleted.
- `cross_cluster_replication.delete_auto_follow_pattern`, `cross_cluster_replication.follow`, `cross_cluster_replication.follow_info`, `cross_cluster_replication.get_auto_follow_pattern`, `cross_cluster_replication.pause_auto_follow_pattern`, `cross_cluster_replication.pause_follow`, `cross_cluster_replication.put_auto_follow_pattern`, `cross_cluster_replication.resume_auto_follow_pattern`, `cross_cluster_replication.resume_follow`, `cross_cluster_replication.stats`, `cross_cluster_replication.unfollow` - Add Time parameter `:master_timeout`: Explicit operation timeout for connection to master node.
- `cross_cluster_replication.follow_stats`, `cross_cluster_replication.forget_follower`, `cross_cluster_replication.stats` - Add Time parameter `:timeout`: Explicit operation timeout.
- `indices/rollover` - Adds Boolean parameter `:target_failure` If set to true, the rollover action will be applied on the failure store of the data stream.
- `inference.get_model` - Parameter `inference_id` no longer required.
- `search_application.search` - Adds Boolean parameter `:typed_keys`: Specify whether aggregation and suggester names should be prefixed by their respective types in the response.
- `security.get_api_key`, `security.query_api_keys` - Add Boolean parameter `:with_profile_uid`: flag to also retrieve the API Key's owner profile uid, if it exists.

New APIs:

- `profiling.topn_functions` - Extracts a list of topN functions from Universal Profiling.
New namespace `data_streams`
- data_streams
- `text_structure.find_field_structure` - Finds the structure of a text field in an index.
- `text_structure/find_message_structure`- Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch.

APIs Migrated from experimental to stable:
- `esql.async_query`
- `esql.query`

New Experimental APIs:
- `connector.update_active_filtering` - Activates the draft filtering rules if they are in a validated state.
- `connector.update_filtering_validation` - Updates the validation info of the draft filtering rules.

## 8.13.0 Release notes

### Client
Expand Down
52 changes: 52 additions & 0 deletions docs/release_notes/814.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
[[release_notes_8_14]]
=== 8.14 Release notes

[discrete]
[[release_notes_8_14_0]]
=== 8.14.0 Release notes

[discrete]
==== Client
* Tested versions of Ruby for 8.14.0: Ruby (MRI) 3.0, 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4.

[discrete]
==== API

API changes:

* All Connector APIs have been migrated to one common namespace `connector`:
** `connector_secret.delete` -> `connector.secret_delete`
** `connector_secret.get` -> `connector.secret_get`
** `connector_secret.post` -> `connector.secret_post`
** `connector_secret.put` -> `connector.secret_put`
** `connector_sync_job.cancel` -> `connector.sync_job_cancel`
** `connector_sync_job.check_in` -> `connector.sync_job_check_in`
** `connector_sync_job.delete` -> `connector.sync_job_delete`
** `connector_sync_job.error` -> `connector.sync_job_error`
** `connector_sync_job.get` -> `connector.sync_job_get`
** `connector_sync_job.post` -> `connector.sync_job_post`
** `connector_sync_job.update_stats` -> `connector.sync_job_update_stats`

* `connector.delete` - Adds Boolean parameter `:delete_sync_jobs`: Determines whether associated sync jobs are also deleted.
* `cross_cluster_replication.delete_auto_follow_pattern`, `cross_cluster_replication.follow`, `cross_cluster_replication.follow_info`, `cross_cluster_replication.get_auto_follow_pattern`, `cross_cluster_replication.pause_auto_follow_pattern`, `cross_cluster_replication.pause_follow`, `cross_cluster_replication.put_auto_follow_pattern`, `cross_cluster_replication.resume_auto_follow_pattern`, `cross_cluster_replication.resume_follow`, `cross_cluster_replication.stats`, `cross_cluster_replication.unfollow` - Add Time parameter `:master_timeout`: Explicit operation timeout for connection to master node.
* `cross_cluster_replication.follow_stats`, `cross_cluster_replication.forget_follower`, `cross_cluster_replication.stats` - Add Time parameter `:timeout`: Explicit operation timeout.
* `indices/rollover` - Adds Boolean parameter `:target_failure` If set to true, the rollover action will be applied on the failure store of the data stream.
* `inference.get_model` - Parameter `inference_id` no longer required.
* `search_application.search` - Adds Boolean parameter `:typed_keys`: Specify whether aggregation and suggester names should be prefixed by their respective types in the response.
* `security.get_api_key`, `security.query_api_keys` - Add Boolean parameter `:with_profile_uid`: flag to also retrieve the API Key's owner profile uid, if it exists.

New APIs:

- `profiling.topn_functions` - Extracts a list of topN functions from Universal Profiling.
New namespace `data_streams`
- data_streams
- `text_structure.find_field_structure` - Finds the structure of a text field in an index.
- `text_structure/find_message_structure`- Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch.

APIs Migrated from experimental to stable:
- `esql.async_query`
- `esql.query`

New Experimental APIs:
- `connector.update_active_filtering` - Activates the draft filtering rules if they are in a validated state.
- `connector.update_filtering_validation` - Updates the validation info of the draft filtering rules.
2 changes: 2 additions & 0 deletions docs/release_notes/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

[discrete]
=== 8.x
* <<release_notes_8_14, 8.14 Release Notes>>
* <<release_notes_8_13, 8.13 Release Notes>>
* <<release_notes_8_12, 8.12 Release Notes>>
* <<release_notes_8110, 8.11 Release Notes>>
Expand Down Expand Up @@ -35,6 +36,7 @@
* <<release_notes_75, 7.5 Release Notes>>
* <<release_notes_70, 7.0 Release Notes>>

include::814.asciidoc[]
include::813.asciidoc[]
include::812.asciidoc[]
include::811.asciidoc[]
Expand Down

0 comments on commit 30925b8

Please sign in to comment.