Releases: elastic/elasticsearch-ruby
7.11.0.pre.1
-Support for Elasticsearch version 7.11.0
-This is a pre-release, full Changelog details will be published with the final release of 7.11.0
7.10.1
Client
- Use 443 for default cloud port, 9200 as the default port for http
EXT:0.0.33
New release of elasticsearch-extensions
:
EXT:0.0.32
New release of elasticsearch-extensions
:
- Fixes parsing Elasticsearch version when a major, minor or patch have more than 1 digit (e.g. 7.10.0) (commit).
- Changes the key of the parameter of Reindex from
target
todest
by @tetsuya-ogawa (commit). - Fixes test cluster clear_cluster option by @Lajcisvk (commit).
- Sanitizes filename in the backup extension (commit).
- Adds 8.0.0 to cluster tasks (commit).
7.10.0
Client
- Support for Elasticsearch version
7.10.0
. - Fixes a bug when building the complete endpoint URL could end with duplicate slashes
//
. - Fixes a bug when building the complete endpoint URL with cloud id could end with duplicate ports #1081.
API
- Fix in RubyDoc comments, some parameters were being duplicated.
- Deprecation notice: Synced flush (
indices.flush_synced
) is deprecated and will be removed in 8.0. Use flush instead.
New API Endpoints
snapshot.clone
API Changes
bulk
,index
,update
: new parameterrequire_alias
(boolean): When true, requires destination to be an alias (default: false) forindex
andupdate
. Forbulk
it setsrequire_alias
for all incoming documents. Defaults to unset (false).
X-Pack
Deprecation notice: searchable_snapshots.repository_stats
is deprecated and is replaced by the Repositories Metering API.
New API Endpoints
close_point_in_time
open_point_in_time
security.clear_api_key_cache
security.grant_api_key
API Changes
cat.ml_datafeeds
,cat.ml_jobs
,machine_learning.close_job
,machine_learning.get_datafeed_stats
,machine_learning.get_datafeeds
,machine_learning.get_job_stats
,machine_learning.get_jobs
,machine_learning.get_overall_buckets
,machine_learning.stop_datafeed
: new parameterallow_no_match
(boolean): Whether to ignore if a wildcard expression matches no datafeeds. (This includes_all
string or when no datafeeds have been specified)
-machine_learning.get_data_frame_analytics
: new parameterverbose
(boolean), whether the stats response should be verbosemachine_learning.get_trained_models
: new parameterinclude
(string), a comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. Default is none.machine_learning.stop_datafeed
: endpoint now accepts abody
: the URL params optionally sent in the bodysecurity.get_role
,security/get_role_mapping
: The name parameter is now a comma-separated list of role-mapping namesmachine_learning.delete_trained_model
,machine_learning.get_trained_models
,machine_learning.get_trained_models_stats
,machine_learning.put_trained_model
: Internal change, url changed from_ml/inference
to_ml/trained_models
7.10.0.pre
-Support for Elasticsearch version 7.10.0
-This is a pre-release, full Changelog details will be published with the final release of 7.10.0
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
andPOST
, the client will always usePOST
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 ifindex_filter
is provided.eql.search
: new parameterswait_for_completion
,keep_on_completion
andkeep_alive
.info
: New parameteraccept_enterprise
: If an enterprise license is installed, return the type and mode as 'enterprise' (default: false).indices.put_mapping
: new parameterwrite_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 parametersjob_id
,requests_per_second
andtimeout
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 parameteraccept_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 withwarn
. - 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 parameterrepository
, name of the snapshot repository, wildcard (*
) patterns are now supported.task.cancel
: new parameterwait_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 parambody
: deleting expired data parameters.machine_learning.delete_data_frame_analytics
new paramtimeout
: controls the time to wait until a job is deleted. Defaults to 1 minute.