7.9.0

7.9.0

Client

• Support for Elasticsearch version 7.9.0.
• Transport/Connection: Considers attributes values for equality - 06ffd03.
• When an API endpoint accepts both GET and POST, the client will always use POST when a request body is present.

API

• Documentation for API endpoints will point out when an API is experimental, beta or unstable.

New API Endpoints

• New namespace: dangling_indices
• dangling_indices.delete_dangling_index
• dangling_indices.import_dangling_index
• dangling_indices.list_dangling_indices
• indices.add_block

Experimental endpoints:

• indices.resolve_index
• simulate_template

API Changes

• field_caps: adds body parameter allowing to filter indices if index_filter is provided.
• eql.search: new parameters wait_for_completion, keep_on_completion and keep_alive.
• info: New parameter accept_enterprise: If an enterprise license is installed, return the type and mode as 'enterprise' (default: false).
• indices.put_mapping: new parameter write_index_only.

X-Pack

New API Endpoints

The Ruby client now supports all the X-Pack API endpoints.

• New namespace autoscaling: autoscaling.delete_autoscaling_policy, autoscaling.get_autoscaling_decision, autoscaling.get_autoscaling_policy, autoscaling.put_autoscaling_policy
• New namespace enrich: enrich.delete_policy, enrich.execute_policy, enrich.get_policy, enrich.put_policy, enrich.stats
• New namespace eql: eql.delete, eql.get, eql.search
• New namespace cross_cluster_replication: cross_cluster_replication.delete_auto_follow_pattern, cross_cluster_replication.follow, cross_cluster_replication.follow_info, cross_cluster_replication.follow_stats, cross_cluster_replication.forget_follower, 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
• New namespace snapshot_lifecycle_management: snapshot_lifecycle_management.delete_lifecycle, snapshot_lifecycle_management.execute_lifecycle, snapshot_lifecycle_management.execute_retention, snapshot_lifecycle_management.get_lifecycle, snapshot_lifecycle_management.get_stats, snapshot_lifecycle_management.get_status, snapshot_lifecycle_management.put_lifecycle, snapshot_lifecycle_management.start, snapshot_lifecycle_management.stop
• indices.create_data_stream
• indices.data_streams_stats
• indices.delete_data_stream
• indices.get_data_stream
• security.clear_cached_privileges
• machine_learning.update_data_frame_analytics

API Changes

• machine_learning.delete_expired_data: new parameters job_id, requests_per_second and timeout

7.8.1

Client

• Support for Elasticsearch version 7.8.1.
• Bug fix: Fixed a bug on the API endpoints documentation for RubyDocs: there was an unnecessary empty new line in the documentation for parameters that have options. So the parameters before that empty newline were not being documented in RubyDocs.

X-Pack

API Changes

• Update to info endpoint. New parameter accept_enterprise (boolean): If an enterprise license is installed, return the type and mode as 'enterprise' (default: false).

7.9.0.pre

• Support for Elasticsearch version 7.9
• This is a pre-release, full Changelog details will be published with the final release of 7.9.0

7.8.0

Client

• Support for Elasticsearch version 7.8.
• Surface deprecation headers from Elasticsearch. When there's a warning response header in Elasticsearch's response, the client will emit a warning with warn.
• Typhoeus is supported again, version 1.4+ and has been added back to the docs.
• Adds documentation and example for integrating with Elastic APM.

API

New API Endpoints

• abort_benchmark
• benchmark
• cluster.delete_voting_config_exclusions
• cluster.post_voting_config_exclusions
• delete_by_rethrottle
• nodes.shutdown
• remote.info

Experimental endpoints:

• cluster.delete_component_template

• cluster.exists_component_template

• cluster.get_component_template

• cluster.put_component_template

• indices.delete_index_template

• indices.exists_index_template

• indices.get_index_template

• indices.put_index_template

• indices.simulate_index_template

API Changes

• cat/thread_pool: size is deprecated.
• indices.get_data_streams: name is now a string instead of list, the name or wildcard expression of the requested data streams.
• indices.put_index_template: new parameter: cause (string), user defined reason for creating/updating the index template.
• indices.simulate_index_template: Two new parameters: create, whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one. cause User defined reason for dry-run creating the new template for simulation purposes.
• snapshot.delete_repository: New parameter repository, name of the snapshot repository, wildcard (*) patterns are now supported.
• task.cancel: new parameter wait_for_completion (boolean) Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false.

X-Pack

New API Endpoints

New namespace: indices

• indices.freeze
• indices.reload_search_analyzers
• indices.unfreeze

New namespace: searchable_snapshots

• clear_cache
• mount
• repository_stats
• stats

API Changes

• machine_learning.delete_expired_data new param body: deleting expired data parameters.
• machine_learning.delete_data_frame_analytics new param timeout: controls the time to wait until a job is deleted. Defaults to 1 minute.

7.8.0.pre

• Support for Elasticsearch version 7.8
• This is a pre-release, full Changelog details will be published with the final release of 7.8.0

7.7.0

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

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.

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

6.8.2

Client

• 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

• Ensure that index argument is considered in rank_eval api b56beea
• Update handling of publish_address in _nodes/http response 68350f9
• Remove percolate Spec (not supported)

7.7.0.pre

• 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

7.6.0

Client

• Support for Elasticsearch version 7.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.

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

API Changes:

• cat.indices: argument bytes options were: b,k,m,g and are now b,k,kb,m,mb,g,gb,t,tb,p,pb.
• delete_by_query: New parameter analyzer - The analyzer to use for the query string.
• indices.put_template: Removed parameters: timeout, flat_settings.
• msearch_template: New Parameter ccs_minimize_roundtrips - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.
• rank_eval: New parameter search_type - Search operation type (options: query_then_fetch,dfs_query_then_fetch).
• search_template: New parameter ccs_minimize_roundtrips - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.

New API endpoints:

• get_script_context
• get_script_languages

Warnings:

Synced flush is deprecated and will be removed in 8.0.

X-Pack

New API endpoints:

• ml/delete_trained_model
• ml/explain_data_frame_analytics
• ml/get_trained_models
• ml/get_trained_models_stats
• ml/put_trained_model

API changes:

• license/get: Added parameter accept_enterprise.
• ml/delete_data_frame_analytics Added parameter force.
• monitoring/bulk - Removed parameter system_version.

7.6.0.pre

Pre-release version of 7.6 client.

• Support for Elasticsearch version 7.6.
• New features: API Key Support, X-Opaque-Id and Faraday 1.0.
• This is a pre-release, full Changelog details will be published with the final release of 7.6.0