Changelog History
Page 5
-
v7.5.0 Changes
February 26, 2020- ๐ 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
andmaster_timeout
parameters are gone.health
: New parameterhealth
.indices
: Addstime
andinclude_unload_segments
parameters.nodes
: Addsbytes
,time
parameters.pending_tasks
: Addstime
parameter.recovery
: Addsactive_only
,detailed
,index
,time
parameters.segments
: Removesindex
parameter and it's now a url part.shards
: Addstime
parameter.snapshots
: Addstime
parameter.tasks
: Addstime
parameter.templates
: Thename
parameter is now passed in as a part but not a parameter.thread_pool
: Thethread_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
- usesdelete_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 goneget_source
:parent
parameter is goneindex
:body
parameter is required,wait_for_shard
is a new parameter,consistency
,include_type_name
,parent
,percolate
,replication
,timestamp
,ttl
parameters are goneindices
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 parametersearch
: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
andupgrade_test
.watcher
:restart
endpoint is gone.
-
v7.4.0 Changes
November 05, 2019๐ This version supports Elasticsearch version 7.4.0
Client
- Accept options passed to #perform_request to avoid infinite retry loop
- ๐ Fix minor typo
API
- ๐ Update documentation of put_script method
XPACK
- โ Add ParamsRegistry in each direcotry and for Xpack top-level API
- โ Add ParamsRegistry for Xpack data_frame API
- โ Add ParamsRegistry for Xpack graph API
- โ Add ParamsRegistry for Xpack license API
- โ Add ParamsRegistry for Xpack MachineLearning API
- ๐ Fix path for loading params_registry files
- โ Add ParamsRegistry for Xpack Migration API
- โ Add ParamsRegistry for Xpack Monitoring API
- โ Add ParamsRegistry for Xpack Rollup API
- โ Add ParamsRegistry for Xpack security API
- โ Add ParamsRegistry for Xpack sql API
- โ Add ParamsRegistry for Xpack watcher API
- โก๏ธ Update missed file with ParamsRegistry
- โก๏ธ Update versions in params registry files
- Add update_data_frame_transform
- ๐ Support Index Lifecycle Management(ILM) API
-
v7.3.0 Changes
August 01, 2019๐ This version supports Elasticsearch server version 7.3.0.
It has the following changes:Client
- โ Add note to readme about the default port value
- โ Add note about exception to default port rule when connecting using Elastic Cloud ID
- Cluster name is variable in cloud id
XPACK
- Support allow_no_match parameter in stop_data_frame_transform
- Add allow_no_match to get_data_frame_transform API
- โ Add missing headers
- Support get_builtin_privileges API
- โก๏ธ Update tests for changed xpack paths
- โ test:integration task in xpack gem shouldn't do anything in favor of test:rest_api
-
v7.2.1 Changes
July 25, 2019๐ This release has a single change:
- ๐ Cluster name is variable in cloud id. See the follow for issue details: #690
-
v7.2.0 Changes
June 26, 2019๐ This client version supports Elasticsearch server version 7.2.0
๐ Notable changes include the addition of the User-Agent header and support for compression with the
compression: true
option on a client.Client
- ๐ Support User-Agent header client team specification
- ๐ Improve code handling headers
- ๐ Handle headers when using JRuby and Manticore
- ๐ Rename method for clarity
- โ Test selecting connections using multiple threads
- ๐ Synchronize access to the connections collection and mutation of @current instance variable
- ๐ Fix specs for selecting a connection
- โ Further fixes to specs for testing selecting connections in parallel
- ๐ Support providing a cloud id
- ๐ Allow a port to be set with a Cloud id and use default if no port is provided
- โ Remove unnecessary check for cloud_id when setting default port
- โ Add documentation for creating client with cloud_id
- ๐ Allow compression with Faraday and supported http adapters
- Put development gem dependencies in gemspec
- No reason to use ! for decompress method name
- Check for the existence of headers before checking headers
- Apply compression headers manually based on general :compression option
- ๐ Use GZIP constant
- โ Group tests into their transport adapters
- ๐ Support compression when using Curb adapter
- ๐ Support compression when using Manticore adapter with JRuby
- ๐ Fix Curb unit test, expecting headers to be merged and not set
- โก๏ธ Update test descriptions for compression settings
- โ Add documentation of 'compression' option on client
- ๐ Improve client documentation for compression option
- Centralize header handling into one method
- Only add Accept-Encoding header if compression option is true
API
- โ Use rewritten test harness from XPACK for rest API tests
- โก๏ธ Include skipped tests and further updates
- โ Delete all repositories and snapshots in a method
- โก๏ธ Further updates to the rest API test runner
- โ Add erroneously removed constants and gems
- โก๏ธ Updates to rest api yaml rspec tasks
- The get_source endpoint should raise an error if the resource is not found
- โ Rename method to clear data in tests and consolidate tasks into one method
- โก๏ธ Update api for 7.2
-
v7.1.0 Changes
May 22, 2019Client
- โก๏ธ Update elasticsearch-transport README
- 0๏ธโฃ Use default port when host and protocol are specified but no port
- ๐ Verify that we have a response object before checking its status
- ๐ Make code more succinct for supporting host with path and no port
- ๐ Support options specified with String keys
- โก๏ธ Update elasticsearch-transport/lib/elasticsearch/transport/client.rb
- โ Add tests showing IPv6 host specified when creating client
API
- โก๏ธ Update links in elasticsearch-api README
DSL 0.1.8
- Swap links elasticsearch.org->elastic.co (@harry-wood)
- โ Add a composite aggregation (@watsonjon)
- โ Don't specify a type when creating mappings in tests
- โก๏ธ Update links in elasticsearch-dsl README
- ๐ Allow Bool query and Bool filter methods to take objects as arguments
- โ Edit tests on bool query / filter to match context
-
v7.0.0 Changes
April 30, 2019๐ This release supports version 7.0 of the Elasticsearch server. There have been no notable updates since the 7.0.0.pre release. Please see the release notes for that version.
-
v7.0.0.pre Changes
April 15, 2019๐ This is a pre-release to support Elasticsearch server version 7.0.0
This version contains the following changes:
- ๐ Added
elastic_ruby_console
executable. It opens a console with the elasticsearch gems you have installed required. - โ Added macro benchmarking framework, available when developing. Use
rake -T
to view all available benchmarking tasks.
Client
- ๐ Fixed failing integration test
- โก๏ธ Updated the Manticore development dependency
- ๐ Fixed a failing Manticore unit test
- โ Removed "turn" and switched the tests to Minitest
- ๐ Fixed integration tests for Patron
- ๐ Allow passing request headers in
perform_request
- โ Added integration test for passing request headers in
perform_request
- โ Added, that request headers are printed in trace output, if set
- ๐ Fix typos in elasticsearch-transport/README.md
- Assert that connection count is at least previous count when reloaded
- โ Adjust test for change in default number of shards on ES 7
- ๐ Abstract logging functionality into a Loggable Module (#556)
- โ Convert client integration tests to rspec
- โ Add flexible configuration in spec helper
- ๐ Use helper methods in spec_helper
- โ Remove minitest client integration tests in favor of rspec test
- ๐จ Convert tests to rspec and refactor client
- minor changes to the client specs
- ๐ Use pry-nav in development for JRuby
- Keep arguments variable name for now
- โ Skip round-robin test for now
- โ Mark test as pending until there is a better way to detect rotating nodes
- โ Remove client unit test in favor of rspec test
- โ Comment-out round-robin test as it occasionally passes and pending is ineffective
- 0๏ธโฃ Document the default host and port constant
- โ Add documentation to spec_helper methods
- ๐จ Redacted password if host info is printed in error message
- โ Adds tests for not including password in logged error message
- The redacted string change will be in 6.1.1
- โ Add more tests for different ways to specify client host argument
- ๐ Do not duplicate connections in connection pool after rebuild (#591)
- โ Ensure that the spec rake task is run as part of integration tests
- ๐ Use constant to define Elasticsearch hosts and avoid yellow status when number of nodes is 1
- โ Update handling of publish_address in _nodes/http response
- โ Add another test for hostname/ipv6:port format
API
- Added the
wait_for_active_shards
parameter to the "Indices Open" API - โ Added the "Indices Split" API
- Added the
wait_for_no_initializing_shards
argument to the "Cluster Health" API - โ Added the "Cluster Remote Info" API
- โ Remove the dependency on "turn"
- โ Clear cluster transient settings in test setups
- โ
Use
YAML.load_documents
in the REST tests runner - โ Removed pinning dependency for Minitest
- โ Replaced the testing framework from Test::Unit to Minites and improved test output
- โ Added, that trace logs are printed when the
TRACE
environment variable is set - โ Removed the "turn" dependency from generated test_helper.rb
- โก๏ธ Update the "Delete By Query" API to support :slices
- Speed up
Elasticsearch::API::Utils.__listify
- Speed up
Elasticsearch::API::Utils.__pathify
- ๐ Use "String#strip" and "String.empty?" in
Utils.__pathify
- ๐ Updated the inline documentation for using scripts in the "Update" API
- โก๏ธ Updated the "Scroll" API inline example with passing the scroll ID in the body
- ๐ Marked the
percolate
method as deprecated and added an example for current percolator - Fixed, that
Utils. __report_unsupported_parameters
andUtils.__ report_unsupported_method
useKernel.warn
so they can be suppressed - Fixed the "greedy" regex in the
Utils.__rescue_from_not_found
method - ๐ Fixed the incorrect
create
method - ๐ Allow passing headers in
perform_request
- Set application/x-ndjson content type on Bulk and Msearch requests
- โก๏ธ Update the Reindex API to support :slices
- ๐ Fixed and improved the YAML tests runner
- Added the
include_type_name
parameter to APIs - ๐ Fixed the helper for unit tests
- โ Removed the requirement for passing the
type
parameter to APIs - โ Removed dead code from the YAML tests runner
- ๐ Fixed the
api:code:generate
Thor task - โ Add copy_settings as valid param to split API
- โ Port api/actions tests to rspec (#543)
- โก๏ธ Update tests to not require type
- ๐ Account for escape_utils not being available for JRuby
- Add nodes/reload_secure_settings endpoint support (#546)
- โ Add new params for search and msearch API
- โ Retrieve stashed variable if referenced in test
- โ Convert cat API tests to rspec
- โ Convert cluster API tests to rspec
- โ Convert indices tests to rspec
- ๐ Fix documentation of #indices.analyze
- ๐ Avoid instantiating an array of valid params for each request, each time it is called (#550)
- โ Add headers to custom client documentation (#527)
- ๐ Fix typos in README
- ๐ Minor update to scroll documentation example
- โ Convert snapshot, ingest, tasks, nodes api tests to rspec
- Update source_includes and source_excludes params names for mget
- Update source_includes and source_excludes params names for get, search, bulk, explain
- Update source_includes and source_excludes params names for get_source
- ๐ Mark _search endpoint as deprecated
- ๐ Link to 6.0 documentation explicitly for _suggest deprecation
- ๐ Update documentation for msearch
- ๐ Update documentation for scroll_id to be in body of scroll endpoint
- โ Remove reference to deprecated format option for _analyze endpoint
- Correct endpoints used for get and put search template
- ๐ Fix minor typo
- Note that a non-empty body argument is required for the bulk api
- โ Add note about empty body in yard documentation
- Support if_primary_term param on index API
- โ Delete test2 template in between tests in case a test is not cleanup up properly
- ๐ Support ignore_throttled option on search API
- โก๏ธ Updates for types removal changes
- โ Add missing update param
- โ Add missing params to methods
- Support if_primary_term param for delete
- โ Delete an index and index template not cleaned up after in rest api tests
- โก๏ธ Update supported params for cat API endpoints
- โก๏ธ Update supported params for cluster API endpoints
- โก๏ธ Update supported params for indices API endpoints
- โก๏ธ Update supported params for ingest API endpoints
- โก๏ธ Update supported params for nodes API endpoints
- โก๏ธ Update supported params for snapshot API endpoints
- โก๏ธ Update missed node API endpoints
- โก๏ธ Update missed tasks API endpoints
- โก๏ธ Update top-level api endpoints
- โ Adjust specs and code after test failures
- ๐ Fix accidental overwrite of index code
- โ Add missing param in cat/thread_pool
- The type argument is not required in the index method
- โ Delete 'nomatch' template to account for lack of test cleanup
- ๐ Ensure that the :index param is supported for cat.segments
- Ensure that the :name param is passed to the templates API
DSL
- ๐ Add inner_hits option support for has_parent query
- ๐ Add inner_hits option support for has_child query
- ๐ Add inner_hits option support for has_parent filter
- ๐ Add inner_hits option support for has_child filter
- โ adds query support for nested queries in filter context (#531)
- โ Convert aggregations/pipeline tests to rspec (#564)
- โ Convert aggregations tests to rspec (#566)
- โ Convert filters tests to rspec (#567)
- Fix bug in applying no_match_filter to indices filter
- โก๏ธ Update test for current elasticsearch version
- ๐ Fix integration tests for join field syntax
- โก๏ธ Update agg scripted metric test for deprecation in ES issue #29328
- ๐ Fix script in update for #29328
- minor: fix spacing
- โ Convert queries tests to rspec (#569)
- โ Add inner_hits test after cherry-picking rspec conversion
- โ Remove tests already converted to rspec
- spec directory structure should mirror code directory structure
- ๐ Support query_string type option
- ๐ Ensure that filters are registered when called on bool queries (#609)
- โ Don't specify a type when creating mappings in tests
XPACK
- ๐ Embedded the source code for the
elasticsearch-xpack
Rubygem - ๐ Fixed the
setup
for YAML integration tests - โ Added missing X-Pack APIs
- ๐ Improved the YAML integration test runner
- โก๏ธ Updated the Rakefile for running integration tests
- โ Added, that password for Elasticsearch is generated
- ๐ Fixed the Watcher example
- โก๏ธ Updated the README
- โ Added gitignore for the
elasticsearch-xpack
Rubygem - โ Add ruby-prof as a development dependency
- Handle multiple roles passed to get_role_mapping
- โก๏ธ Minor updates to xpack api methods (#586)
- ๐ Support freeze and unfreeze APIs
- โ Rewrite xpack rest api yaml test handler (#585)
- โก๏ธ Updates to take into account SSL settings
- ๐ Fix mistake in testing version range so test can be skipped
- โฌ๏ธ Support set_upgrade_mode machine learning API
- Support typed_keys and rest_total_hits_as_int params for rollup_search
- ๐ Improve string output for xpack rest api tests
- ๐ Fix logic in version checking
- Support if_seq_no and if_primary_term in put_watch
- Don't test execute_watch/60_http_input because of possible Docker issue
- ๐ Support api key methods
- ๐ Fix minor typo in test description
- ๐ Fix issue with replacing argument value with an Integer value
- Support transform_and_set in yaml tests
- โ Skip two more tests
- ๐ Run security tests against elasticsearch 7.0.0-rc2
- Account for error when forecast_id is not provided and legacy path is used
- โ Blacklist specific tests, not the whole file
- ๐ Fix version check for skipping test
- ๐ Added
-
v6.8.2 Changes
April 29, 2020Client
- ๐ Accept options passed to #perform_request to avoid infinite retry loop - #837
๐ API Key Support
๐ The client now supports API Key Authentication, check "Authentication" on the transport README for information on how to use it.
๐ X-Opaque-Id Support
๐ The client now supports identifying running tasks with X-Opaque-Id. Check transport README for information on how to use X-Opaque-Id.
Faraday migrated to 1.0
We're now using version 1.0 of Faraday:
- ๐ The client initializer was modified but this should not disrupt final users at all, check this commit for more information.
- ๐ Migrated error checking to remove the deprecated
Faraday::Error
namespace. - This change is not compatible with Typhoeus. The latest release is 1.3.1, but it's 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. - โ 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.
โฌ๏ธ Reference: Upgrading - Faraday 1.0
๐ Pull Request
API
-
v6.8.1 Changes
January 21, 2020- ๐ Lock the version of Faraday: Faraday 1.0 was released with breaking changes. Thank you @taylorthurlow ๐ (#752)
- โ Add support for Ruby 2.7
- ๐ 6.x releases are now tested in the latests Ruby versions: 2.4.9, 2.5.7, 2.6.5 and 2.7.0
- ๐ Fix bad range value error