Skip to content

Commit

Permalink
[DOCS] Update Changelog and Release Notes for 7.7
Browse files Browse the repository at this point in the history
  • Loading branch information
picandocodigo committed May 13, 2020
1 parent b1434e2 commit 2a15af3
Show file tree
Hide file tree
Showing 4 changed files with 187 additions and 2 deletions.
60 changes: 58 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,63 @@
## 7.7.0.pre
## 7.7.0

This version drops support for Ruby 2.4 since it's reached it's end of life.

### Client

- Support for Elasticsearch version `7.7`
- This is a pre-release, full Changelog details will be published with the final release of 7.7.0

#### Custom Headers

You can set custom HTTP headers on the client's initializer or pass them as a parameter to any API endpoint. [More info and code examples](https://github.com/elastic/elasticsearch-ruby/tree/7.x/elasticsearch-transport#custom-http-headers).

### API

#### API Changes

- Clean: Removes up some deprecated endpoints: `abort_benchmark`, `benchmark`, `delete_by_rethrottle`, `nodes.shutdown`, `remote.info`.
- `expand_wildcards` Whether to expand wildcard expressions to concrete indices that are open, closed or both. Options: open, closed, hidden, none, all. `hidden` option is new. It was also added to the following endpoints: `cat.aliases`, `cat.indices`.
- `delete_by_query`: Parameter `slices` can now be set to `auto`.
- `reindex`: Parameter `slices` can now be set to `auto`.
- `update_by_query`: Parameter `slices` can now be set to `auto`.
- `snapshot.cleanup_repository`: Parameter `body` is removed.

#### New API Endpoints

- `cluster.delete_component_template`
- `cluster.get_component_template`
- `cluster.put_component_template`
- `indices.create_data_stream` (experimental)
- `indices.delete_data_stream` (experimental)
- `indices.get_data_stream` (experimental)

### X-Pack

#### API Changes

- `machine_learing.get_trained_models`: New parameter `tags`
- `machine_learning.put_datafeed`, `machine_learning.update_datafeed`: Added parameters `ignore_unavailable`, `allow_no_indices`, `ignore_throttled`, `expand_wildcards`
- `reload_secure_settings`: New parameter `body`, an object containing the password for the keystore.

#### New API Endpoints

- `async_search.delete`
- `async_search.get`
- `async_search.submit`
- `cat.ml_data_frame_analytics`
- `cat.ml_datafeeds`
- `cat.ml_jobs`
- `cat.ml_trained_models`
- `cat.transform`
- `cat.transforms`
- `machine_learning.estimate_model_memory`
- `transform.delete_transform`
- `transform.get_transform`
- `transform.get_transform_stats`
- `transform.preview_transform`
- `transform.put_transform`
- `transform.start_transform`
- `transform.stop_transform`
- `transform.update_transform`

## 7.6.0

Expand Down
55 changes: 55 additions & 0 deletions docs/release_notes/75.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
[[release_notes_75]]
=== 7.5 Release notes

- Support for Elasticsearch 7.5.
- Update API spec generator: The code for Elasticsearch OSS and X-Pack APIs is being generated from the rest api spec.
- Specs have been updated to address new/deprecated parameters.
- Ruby versions tested: 2.3.8, 2.4.9, 2.5.7, 2.6.5 and 2.7.0 (new).

=== API

Endpoints that changed:

- `_bulk`: body is now required as an argument.
- `cat`: `local` and `master_timeout` parameters are gone.
- `health`: New parameter `health`.
- `indices`: Adds `time` and `include_unload_segments` parameters.
- `nodes`: Adds `bytes`, `time` parameters.
- `pending_tasks`: Adds `time` parameter.
- `recovery`: Adds `active_only`, `detailed`, `index`, `time` parameters.
- `segments`: Removes `index` parameter and it's now a url part.
- `shards`: Adds `time` parameter.
- `snapshots`: Adds `time` parameter.
- `tasks`: Adds `time` parameter.
- `templates`: The `name` parameter is now passed in as a part but not a parameter.
- `thread_pool`: The `thread_pool_patterns` parameter is now passed in as a part but not as a parameter.
- `cluster`
- `put_settings`: body is required.
- `state`: `index_templates` is gone.
- `node_id` is now a url part.
- `delete` - `parent` parameter is gone.
- `delete_by_query`: `analyzer` parameters are gone, `max_docs` is a new parameter, `body` is now a required parameter.
- `delete_by_query_rethrottle` new endpoint.
- `delete_by_rethrottle` - uses `delete_by_query_rethrottle` and hasn't changed.
- `exists`, `exists_source`, `explain`: `parent` parameter is gone.
- `field_caps`: `fields` param is no longer required.
- `get`: `parent` parameter is gone
- `get_source`: `parent` parameter is gone
- `index`: `body` parameter is required, `wait_for_shard` is a new parameter, `consistency`, `include_type_name`, `parent`, `percolate`, `replication`, `timestamp`, `ttl` parameters are gone
- `indices`
- `get`: `feature` paramatere was deprecated and is gone.
- `delete_aliases`, `put_alias`: URL changed internally to 'aliases' instead of 'alias' but shouldn't affect the client's API.
- `render_search_template`: `id` is now a part not a parameter
- `search`: `fielddata_fields`, `include_type_name`, `fields`, `ignore_indices`, `lowercase_expanded_terms`, `query_cache`, `source` parameters are gone, `ccs_minimize_roundtrips`, `track_scores` are new parameters.
- `tasks` - `list`: task_id is not supported anymore, it's in get now.
- `termvectors`: `parent` parameter is gone.
- `update`: `version` parameter is not supported anymore.

=== X-Pack

Some urls changed internally to remove `_xpack`, but it shouldn't affect the client's API.

- `explore`: `index` is now required.
- `info`: `human` parameter is gone.
- `migration`: some endpoints are gone: `get_assistance`, `get_assistance_test` and `upgrade_test`.
- `watcher`: `restart` endpoint is gone.
61 changes: 61 additions & 0 deletions docs/release_notes/77.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
[[release_notes_77]]
=== 7.7 Release notes

This version drops support for Ruby 2.4 since it's reached it's end of life.

=== Client

- Support for Elasticsearch version `7.7`

==== Custom Headers

You can set custom HTTP headers on the client's initializer or pass them as a parameter to any API endpoint. https://github.com/elastic/elasticsearch-ruby/tree/7.x/elasticsearch-transport#custom-http-headers[More info and code examples].

=== API

==== API Changes

- Clean: Removes up some deprecated endpoints: `abort_benchmark`, `benchmark`, `delete_by_rethrottle`, `nodes.shutdown`, `remote.info`.
- `expand_wildcards` Whether to expand wildcard expressions to concrete indices that are open, closed or both. Options: open, closed, hidden, none, all. `hidden` option is new. It was also added to the following endpoints: `cat.aliases`, `cat.indices`.
- `delete_by_query`: Parameter `slices` can now be set to `auto`.
- `reindex`: Parameter `slices` can now be set to `auto`.
- `update_by_query`: Parameter `slices` can now be set to `auto`.
- `snapshot.cleanup_repository`: Parameter `body` is removed.

==== New API Endpoints

- `cluster.delete_component_template`
- `cluster.get_component_template`
- `cluster.put_component_template`
- `indices.create_data_stream` (experimental)
- `indices.delete_data_stream` (experimental)
- `indices.get_data_stream` (experimental)

=== X-Pack

==== API Changes

- `machine_learing.get_trained_models`: New parameter `tags`
- `machine_learning.put_datafeed`, `machine_learning.update_datafeed`: Added parameters `ignore_unavailable`, `allow_no_indices`, `ignore_throttled`, `expand_wildcards`
- `reload_secure_settings`: New parameter `body`, an object containing the password for the keystore.

==== New API Endpoints

- `async_search.delete`
- `async_search.get`
- `async_search.submit`
- `cat.ml_data_frame_analytics`
- `cat.ml_datafeeds`
- `cat.ml_jobs`
- `cat.ml_trained_models`
- `cat.transform`
- `cat.transforms`
- `machine_learning.estimate_model_memory`
- `transform.delete_transform`
- `transform.get_transform`
- `transform.get_transform_stats`
- `transform.preview_transform`
- `transform.put_transform`
- `transform.start_transform`
- `transform.stop_transform`
- `transform.update_transform`
13 changes: 13 additions & 0 deletions docs/release_notes/index.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[[release_notes]]
== Release Notes

=== 7.x
* <<release_notes_77, 7.7 Release Notes>>
* <<release_notes_76, 7.6 Release Notes>>
* <<release_notes_75, 7.5 Release Notes>>
* <<release_notes_70, 7.0 Release Notes>>

include::77.asciidoc[]
include::76.asciidoc[]
include::75.asciidoc[]
include::70.asciidoc[]

0 comments on commit 2a15af3

Please sign in to comment.