Skip to content

Commit 4485431

Browse files
picandocodigopicandocodigo
committed
[Docs] Adds release notes to Elastic docs
1 parent d1c7881 commit 4485431

File tree

4 files changed

+313
-0
lines changed

4 files changed

+313
-0
lines changed

‎docs/release_notes/7.0.asciidoc

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
== 7.0 Release notes
2+
3+
This version contains the following changes:
4+
5+
* Added `elastic_ruby_console` executable. It opens a console with the elasticsearch gems you have installed required.
6+
* Added macro benchmarking framework, available when developing. Use `rake -T` to view all available benchmarking tasks.
7+
8+
=== Client
9+
10+
* Fixed failing integration test
11+
* Updated the Manticore development dependency
12+
* Fixed a failing Manticore unit test
13+
* Removed "turn" and switched the tests to Minitest
14+
* Fixed integration tests for Patron
15+
* Allow passing request headers in `perform_request`
16+
* Added integration test for passing request headers in `perform_request`
17+
* Added, that request headers are printed in trace output, if set
18+
* Fix typos in elasticsearch-transport/README.md
19+
* Assert that connection count is at least previous count when reloaded
20+
* Adjust test for change in default number of shards on ES 7
21+
* Abstract logging functionality into a Loggable Module (#556)
22+
* Convert client integration tests to rspec
23+
* Add flexible configuration in spec helper
24+
* Use helper methods in spec_helper
25+
* Remove minitest client integration tests in favor of rspec test
26+
* Convert tests to rspec and refactor client
27+
* minor changes to the client specs
28+
* Use pry-nav in development for JRuby
29+
* Keep arguments variable name for now
30+
* Skip round-robin test for now
31+
* Mark test as pending until there is a better way to detect rotating nodes
32+
* Remove client unit test in favor of rspec test
33+
* Comment-out round-robin test as it occasionally passes and pending is ineffective
34+
* Document the default host and port constant
35+
* Add documentation to spec_helper methods
36+
* Redacted password if host info is printed in error message
37+
* Adds tests for not including password in logged error message
38+
* The redacted string change will be in 6.1.1
39+
* Add more tests for different ways to specify client host argument
40+
* Do not duplicate connections in connection pool after rebuild (#591)
41+
* Ensure that the spec rake task is run as part of integration tests
42+
* Use constant to define Elasticsearch hosts and avoid yellow status when number of nodes is 1
43+
* Update handling of publish_address in _nodes/http response
44+
* Add another test for hostname/ipv6:port format
45+
46+
=== API
47+
48+
* Added the `wait_for_active_shards` parameter to the "Indices Open" API
49+
* Added the "Indices Split" API
50+
* Added the `wait_for_no_initializing_shards` argument to the "Cluster Health" API
51+
* Added the "Cluster Remote Info" API
52+
* Remove the dependency on "turn"
53+
* Clear cluster transient settings in test setups
54+
* Use `YAML.load_documents` in the REST tests runner
55+
* Removed pinning dependency for Minitest
56+
* Replaced the testing framework from Test::Unit to Minites and improved test output
57+
* Added, that trace logs are printed when the `TRACE` environment variable is set
58+
* Removed the "turn" dependency from generated test_helper.rb
59+
* Update the "Delete By Query" API to support :slices
60+
* Speed up `Elasticsearch::API::Utils.__listify`
61+
* Speed up `Elasticsearch::API::Utils.__pathify`
62+
* Use "String#strip" and "String.empty?" in `Utils.__pathify`
63+
* Updated the inline documentation for using scripts in the "Update" API
64+
* Updated the "Scroll" API inline example with passing the scroll ID in the body
65+
* Marked the `percolate` method as deprecated and added an example for current percolator
66+
* Fixed, that `Utils.__report_unsupported_parameters` and `Utils.__report_unsupported_method` use `Kernel.warn` so they can be suppressed
67+
* Fixed the "greedy" regex in the `Utils.__rescue_from_not_found` method
68+
* Fixed the incorrect `create` method
69+
* Allow passing headers in `perform_request`
70+
* Set application/x-ndjson content type on Bulk and Msearch requests
71+
* Update the Reindex API to support :slices
72+
* Fixed and improved the YAML tests runner
73+
* Added the `include_type_name` parameter to APIs
74+
* Fixed the helper for unit tests
75+
* Removed the requirement for passing the `type` parameter to APIs
76+
* Removed dead code from the YAML tests runner
77+
* Fixed the `api:code:generate` Thor task
78+
* Add copy_settings as valid param to split API
79+
* Port api/actions tests to rspec (#543)
80+
* Update tests to not require type
81+
* Account for escape_utils not being available for JRuby
82+
* Add nodes/reload_secure_settings endpoint support (#546)
83+
* Add new params for search and msearch API
84+
* Retrieve stashed variable if referenced in test
85+
* Convert cat API tests to rspec
86+
* Convert cluster API tests to rspec
87+
* Convert indices tests to rspec
88+
* Fix documentation of #indices.analyze
89+
* Avoid instantiating an array of valid params for each request, each time it is called (#550)
90+
* Add headers to custom client documentation (#527)
91+
* Fix typos in README
92+
* Minor update to scroll documentation example
93+
* Convert snapshot, ingest, tasks, nodes api tests to rspec
94+
* Update source_includes and source_excludes params names for mget
95+
* Update source_includes and source_excludes params names for get, search, bulk, explain
96+
* Update source_includes and source_excludes params names for get_source
97+
* Mark _search endpoint as deprecated
98+
* Link to 6.0 documentation explicitly for _suggest deprecation
99+
* Update documentation for msearch
100+
* Update documentation for scroll_id to be in body of scroll endpoint
101+
* Remove reference to deprecated format option for _analyze endpoint
102+
* Correct endpoints used for get and put search template
103+
* Fix minor typo
104+
* Note that a non-empty body argument is required for the bulk api
105+
* Add note about empty body in yard documentation
106+
* Support if_primary_term param on index API
107+
* Delete test2 template in between tests in case a test is not cleanup up properly
108+
* Support ignore_throttled option on search API
109+
* Updates for types removal changes
110+
* Add missing update param
111+
* Add missing params to methods
112+
* Support if_primary_term param for delete
113+
* Delete an index and index template not cleaned up after in rest api tests
114+
* Update supported params for cat API endpoints
115+
* Update supported params for cluster API endpoints
116+
* Update supported params for indices API endpoints
117+
* Update supported params for ingest API endpoints
118+
* Update supported params for nodes API endpoints
119+
* Update supported params for snapshot API endpoints
120+
* Update missed node API endpoints
121+
* Update missed tasks API endpoints
122+
* Update top-level api endpoints
123+
* Adjust specs and code after test failures
124+
* Fix accidental overwrite of index code
125+
* Add missing param in cat/thread_pool
126+
* The type argument is not required in the index method
127+
* Delete 'nomatch' template to account for lack of test cleanup
128+
* Ensure that the :index param is supported for cat.segments
129+
* Ensure that the :name param is passed to the templates API
130+
131+
=== DSL
132+
133+
* Add inner_hits option support for has_parent query
134+
* Add inner_hits option support for has_child query
135+
* Add inner_hits option support for has_parent filter
136+
* Add inner_hits option support for has_child filter
137+
* adds query support for nested queries in filter context (#531)
138+
* Convert aggregations/pipeline tests to rspec (#564)
139+
* Convert aggregations tests to rspec (#566)
140+
* Convert filters tests to rspec (#567)
141+
* Fix bug in applying no_match_filter to indices filter
142+
* Update test for current elasticsearch version
143+
* Fix integration tests for join field syntax
144+
* Update agg scripted metric test for deprecation in ES issue #29328
145+
* Fix script in update for #29328
146+
* minor: fix spacing
147+
* Convert queries tests to rspec (#569)
148+
* Add inner_hits test after cherry-picking rspec conversion
149+
* Remove tests already converted to rspec
150+
* spec directory structure should mirror code directory structure
151+
* Support query_string type option
152+
* Ensure that filters are registered when called on bool queries (#609)
153+
* Don't specify a type when creating mappings in tests
154+
155+
=== XPACK
156+
157+
* Embedded the source code for the `elasticsearch-xpack` Rubygem
158+
* Fixed the `setup` for YAML integration tests
159+
* Added missing X-Pack APIs
160+
* Improved the YAML integration test runner
161+
* Updated the Rakefile for running integration tests
162+
* Added, that password for Elasticsearch is generated
163+
* Fixed the Watcher example
164+
* Updated the README
165+
* Added gitignore for the `elasticsearch-xpack` Rubygem
166+
* Add ruby-prof as a development dependency
167+
* Handle multiple roles passed to get_role_mapping
168+
* Minor updates to xpack api methods (#586)
169+
* Support freeze and unfreeze APIs
170+
* Rewrite xpack rest api yaml test handler (#585)
171+
* Updates to take into account SSL settings
172+
* Fix mistake in testing version range so test can be skipped
173+
* Support set_upgrade_mode machine learning API
174+
* Support typed_keys and rest_total_hits_as_int params for rollup_search
175+
* Improve string output for xpack rest api tests
176+
* Fix logic in version checking
177+
* Support if_seq_no and if_primary_term in put_watch
178+
* Don't test execute_watch/60_http_input because of possible Docker issue
179+
* Support api key methods
180+
* Fix minor typo in test description
181+
* Fix issue with replacing argument value with an Integer value
182+
* Support transform_and_set in yaml tests
183+
* Skip two more tests
184+
* Run security tests against elasticsearch 7.0.0-rc2
185+
* Account for error when forecast_id is not provided and legacy path is used
186+
* Blacklist specific tests, not the whole file
187+
* Fix version check for skipping test

‎docs/release_notes/7.5.asciidoc

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
== 7.5 Release notes
2+
3+
- Support for Elasticsearch 7.5.
4+
- Update API spec generator: The code for Elasticsearch OSS and X-Pack APIs is being generated from the rest api spec.
5+
- Specs have been updated to address new/deprecated parameters.
6+
- Ruby versions tested: 2.3.8, 2.4.9, 2.5.7, 2.6.5 and 2.7.0 (new).
7+
8+
=== API
9+
10+
Endpoints that changed:
11+
- `_bulk`: body is now required as an argument.
12+
- `cat`: `local` and `master_timeout` parameters are gone.
13+
- `health`: New parameter `health`.
14+
- `indices`: Adds `time` and `include_unload_segments` parameters.
15+
- `nodes`: Adds `bytes`, `time` parameters.
16+
- `pending_tasks`: Adds `time` parameter.
17+
- `recovery`: Adds `active_only`, `detailed`, `index`, `time` parameters.
18+
- `segments`: Removes `index` parameter and it's now a url part.
19+
- `shards`: Adds `time` parameter.
20+
- `snapshots`: Adds `time` parameter.
21+
- `tasks`: Adds `time` parameter.
22+
- `templates`: The `name` parameter is now passed in as a part but not a parameter.
23+
- `thread_pool`: The `thread_pool_patterns` parameter is now passed in as a part but not as a parameter.
24+
- `cluster`
25+
- `put_settings`: body is required.
26+
- `state`: `index_templates` is gone.
27+
- `node_id` is now a url part.
28+
- `delete` - `parent` parameter is gone.
29+
- `delete_by_query`: `analyzer` parameters are gone, `max_docs` is a new parameter, `body` is now a required parameter.
30+
- `delete_by_query_rethrottle` new endpoint.
31+
- `delete_by_rethrottle` - uses `delete_by_query_rethrottle` and hasn't changed.
32+
- `exists`, `exists_source`, `explain`: `parent` parameter is gone.
33+
- `field_caps`: `fields` param is no longer required.
34+
- `get`: `parent` parameter is gone
35+
- `get_source`: `parent` parameter is gone
36+
- `index`: `body` parameter is required, `wait_for_shard` is a new parameter, `consistency`, `include_type_name`, `parent`, `percolate`, `replication`, `timestamp`, `ttl` parameters are gone
37+
- `indices`
38+
- `get`: `feature` paramatere was deprecated and is gone.
39+
- `delete_aliases`, `put_alias`: URL changed internally to 'aliases' instead of 'alias' but shouldn't affect the client's API.
40+
- `render_search_template`: `id` is now a part not a parameter
41+
- `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.
42+
- `tasks` - `list`: task_id is not supported anymore, it's in get now.
43+
- `termvectors`: `parent` parameter is gone.
44+
- `update`: `version` parameter is not supported anymore.
45+
46+
=== X-PACK
47+
48+
Some urls changed internally to remove `_xpack`, but it shouldn't affect the client's API.
49+
50+
- `explore`: `index` is now required.
51+
- `info`: `human` parameter is gone.
52+
- `migration`: some endpoints are gone: `get_assistance`, `get_assistance_test` and `upgrade_test`.
53+
- `watcher`: `restart` endpoint is gone.

‎docs/release_notes/7.6.asciidoc

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
== 7.6 Release notes
2+
3+
=== Client
4+
5+
* Support for Elasticsearch version 7.6.
6+
* Last release supporting Ruby 2.4. Ruby 2.4 has reached it's end of life and no more security updates will be provided, users are suggested to update to a newer version of Ruby.
7+
8+
==== API Key Support
9+
10+
The client now supports API Key Authentication, check "Authentication" on the https://github.com/elastic/elasticsearch-ruby/tree/7.x/elasticsearch-transport#authentication[transport README] for information on how to use it.
11+
12+
==== X-Opaque-Id Support
13+
14+
The client now supports identifying running tasks with X-Opaque-Id. Check https://github.com/elastic/elasticsearch-ruby/tree/7.x/elasticsearch-transport#identifying-running-tasks-with-x-opaque-id[transport README] for information on how to use X-Opaque-Id.
15+
16+
==== Faraday migrated to 1.0
17+
18+
We're now using version 1.0 of Faraday:
19+
20+
* The client initializer was modified but this should not disrupt final users at all, check this commit for more information.
21+
* Migrated error checking to remove the deprecated Faraday::Error namespace.
22+
* *This change is not compatible with https://github.com/typhoeus/typhoeus[Typhoeus]*. The latest release is 1.3.1, but it's https://github.com/typhoeus/typhoeus/blob/v1.3.1/lib/typhoeus/adapters/faraday.rb#L100[still using the deprecated `Faraday::Error` namespace]. This has been fixed on master, but the last release was November 6, 2018. Version 1.4.0 should be ok once it's released.
23+
* Note: Faraday 1.0 drops official support for JRuby. It installs fine on the tests we run with JRuby in this repo, but it's something we should pay attention to.
24+
25+
Reference: https://github.com/lostisland/faraday/blob/master/UPGRADING.md[Upgrading - Faraday 1.0]
26+
27+
https://github.com/elastic/elasticsearch-ruby/pull/808[Pull Request]
28+
29+
=== API
30+
31+
==== API Changes:
32+
33+
- `cat.indices`: argument `bytes` options were: `b,k,m,g` and are now `b,k,kb,m,mb,g,gb,t,tb,p,pb`.
34+
- `delete_by_query`: New parameter `analyzer` - The analyzer to use for the query string.
35+
- `indices.put_template`: Removed parameters: `timeout`, `flat_settings`.
36+
- `msearch_template`: New Parameter `ccs_minimize_roundtrips` - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.
37+
- `rank_eval`: New parameter `search_type` - Search operation type (options: `query_then_fetch,dfs_query_then_fetch`).
38+
- `search_template`: New parameter `ccs_minimize_roundtrips` - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.
39+
40+
==== New API endpoints:
41+
42+
- `get_script_context`
43+
- `get_script_languages`
44+
45+
==== Warnings:
46+
47+
Synced flush is deprecated and will be removed in 8.0.
48+
49+
=== X-Pack
50+
51+
==== New API endpoints:
52+
53+
- `ml/delete_trained_model`
54+
- `ml/explain_data_frame_analytics`
55+
- `ml/get_trained_models`
56+
- `ml/get_trained_models_stats`
57+
- `ml/put_trained_model`
58+
59+
==== API changes:
60+
61+
- `license/get`: Added parameter `accept_enterprise`.
62+
- `ml/delete_data_frame_analytics` Added parameter `force`.
63+
- `monitoring/bulk` - Removed parameter `system_version`.

‎docs/releasenotes.asciidoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
= Release Notes
2+
3+
== 7.x
4+
* <<7.6, 7.6 Release Notes>>
5+
* <<7.5, 7.5 Release Notes>>
6+
* <<7.0, 7.0 Release Notes>>
7+
8+
include::release_notes/7.6.asciidoc[]
9+
include::release_notes/7.5.asciidoc[]
10+
include::release_notes/7.0.asciidoc[]

0 commit comments

Comments
 (0)