diff --git a/.github/workflows/8.x.yml b/.github/workflows/8.19.yml similarity index 100% rename from .github/workflows/8.x.yml rename to .github/workflows/8.19.yml diff --git a/.github/workflows/otel.yml b/.github/workflows/otel.yml index bcd39c02a9..01d768b96d 100644 --- a/.github/workflows/otel.yml +++ b/.github/workflows/otel.yml @@ -2,10 +2,10 @@ name: opentelemetry on: push: branches: - - 8.x + - 8.19 pull_request: branches: - - 8.x + - 8.19 jobs: test-otel: name: 'Test Open Telemetry' diff --git a/CHANGELOG.md b/CHANGELOG.md index a88bf48fc9..bb83e99dfc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,16 +1,124 @@ *See the full release notes on the official documentation website: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/release_notes.html* +## 8.19.0 Release notes + +[[release_notes_8_19]] +=== 8.19 Release notes + +[discrete] +[[release_notes_8_19_0]] +## 8.19.0 Release notes + +#### Client + +Tested versions of Ruby for 8.19.0: Ruby (MRI) 3.1, 3.2, 3.3, 3.4. JRuby 9.3, JRuby 9.4 and JRuby 10. + +#### API changes + +* `cluster.get_component_template` - Adds `flat_settings` boolean parameter, return settings in flat format (default: false). Adds `settings_filter` String parameter, filter out results, for example to filter out sensitive information. +* `cluster.put_component_template` - Removes `timeout` parameter, adds `cause` String parameter, used defined reason for creation. +* `create` - Adds `require_alias` and `require_data_stream` boolean parameters, to specify required type to be created. +* `eql.search` - Adds `ccs_minimize_roundtrips`, `ignore_unavailable`, `allow_no_indices` boolean parameters and `expand_wildcards` String parameter. +* `esql.async_query` - Adds `allow_partial_results` boolean parameter. +* `esql.async_query_get` - Adds `format` String parameter (e.g. json, yaml). +* `esql.query` - Adds `allow_partial_results` boolean parameter. +* `indices.recovery` - Adds `ignore_unavailable`, `allow_no_indices` boolean parameters and `expand_wildcards` String parameter. +* `msearch` - Adds `ignore_unavailable`, `ignore_throttled`, `allow_no_indices`, `include_named_queries_score` boolean parameters, `expand_wildcards` String parameter and `routing`, a comma-separated list of specific routing values. +* `open_point_in_time` - Adds `max_concurrent_shard_requests` parameter, the number of concurrent shard requests per node executed concurrently when opening this point-in-time +* `reindex` - Adds `require_alias` boolean parameter. +* `search_mvt` - Adds `grid_agg` String parameter, aggregation used to create a grid for `field`. +* `snapshot.repository_analyze` - Adds `register_operation_count` parameter, the minimum number of linearizable register operations to perform in total. + +Time parameters `master_timeout` and `timeout` have been added to the following APIs: + +* `index_lifecycle_management`: +** `delete_lifecycle` +** `get_lifecycle` +** `put_lifecycle` +** `start` +** `stop` +** `explain_lifecycle` - Only `master_timeout` + +* `ingest`: +** `delete_geoip_database` +** `delete_ip_location_database` +** `put_geoip_database` +** `put_ip_location_database` + +#### New APIs + +* `indices.delete_data_stream_options` - Deletes the data stream options of the selected data streams. +* `indices.get_data_stream_options` - Returns the data stream options of the selected data streams. +* `indices.get_data_stream_settings` - Gets a data stream's settings. +* `indices.put_data_stream_options` - Updates the data stream options of the selected data streams. +* `indices.put_data_stream_settings` - Updates a data stream's settings. +* `inference.put_amazonsagemaker` - Configure an Amazon SageMaker inference endpoint. +* `inference.put_custom` - Configure a custom inference endpoint. +* `inference.put_deepseek` - Configure a DeepSeek inference endpoint. + + +## 8.18.0 Release notes + +### API + +#### New APIs: + +* `esql.async_query_stop` - Stops a previously submitted async query request given its ID and collects the results. +* `inference.chat_completion_unified` - Perform chat completion inference +* `inference.completion` - Perform completion inference +* `inference.put_alibabacloud` - Configure an AlibabaCloud AI Search inference endpoint +* `inference.put_amazonbedrock` - Configure an Amazon Bedrock inference endpoint +* `inference.put_anthropic` - Configure an Anthropic inference endpoint +* `inference.put_azureaistudio` - Configure an Azure AI Studio inference endpoint +* `inference.put_azureopenai` - Configure an Azure OpenAI inference endpoint +* `inference.put_cohere` - Configure a Cohere inference endpoint +* `inference.put_elasticsearch` - Configure an Elasticsearch inference endpoint +* `inference.put_elser` - Configure an ELSER inference endpoint +* `inference.put_googleaistudio` - Configure a Google AI Studio inference endpoint +* `inference.put_googlevertexai` - Configure a Google Vertex AI inference endpoint +* `inference.put_hugging_face` - Configure a HuggingFace inference endpoint +* `inference.put_jinaai` - Configure a JinaAI inference endpoint +* `inference.put_mistral` - Configure a Mistral inference endpoint +* `inference.put_openai` - Configure an OpenAI inference endpoint +* `inference.put_voyageai` - Configure a VoyageAI inference endpoint +* `inference.put_watsonx` - Configure a Watsonx inference endpoint +* `inference.rerank` - Perform reranking inference +* `inference.sparse_embedding` - Perform sparse embedding inference +* `inference.stream_inference` renamed to `inference.stream_completion` - Perform streaming completion inference. +* `inference.text_embedding` - Perform text embedding inference + +#### Updated APIs: + +* `bulk`, `create`, `index`, `update` - Add Boolean parameter `:include_source_on_error`, if to include the document source in the error message in case of parsing errors (defaults to true). +* `cat.segments` + * Adds Boolean parameter `:local`, return local information, do not retrieve the state from master node (default: false). + * Adds Time parameter `:master_timeout`, explicit operation timeout for connection to master node. +* `cat.tasks` + * Adds Time parameter `:timeout`, period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * Adds Boolean parameter `:wait_for_completion`, if `true`, the request blocks until the task has completed. +* `eql.search` + * Adds Boolean parameter `:allow_partial_search_results`, control whether the query should keep running in case of shard failures, and return partial results. + * Adds Boolean parameter `:allow_partial_sequence_results`, control whether a sequence query should return partial results or no results at all in case of shard failures. This option has effect only if [allow_partial_search_results] is true. +* `index_lifecycle_management.delete_lifecycle`, `index_lifecycle_management.explain_lifecycle`, `index_lifecycle_management.get_lifecycle`, `index_lifecycle_management.put_lifecycle`, `index_lifecycle_management.start`, `index_lifecycle_management.stop`, remove `:master_timeout`, `:timeout` parameters. +* `indices.resolve_cluster` - Adds `:timeout` parameter, `:name` no longer a required parameter. +* `indices.rollover` - Removes target_failure_store parameter. +* `ingest.delete_geoip_database`, `ingest.delete_ip_location_database`, `put_geoip_database`, `put_ip_location_database` remove `:master_timeout`, `:timeout` parameters. +* `machine_learning.start_trained_model_deployment` - Adds body request parameter, the settings for the trained model deployment. + + ## 8.17.2 Release notes ### API -New APIs: +#### New APIs: + * `esql.async_query_delete` * `indices.get_data_lifecycle_stats` * `inference.update` * `security.delegate_pki` -Updates APIs: +#### Updated APIs: + * `async_search.submit` - Adds `keep_alive` Time parameter. * `indices.put_template` - Adds `cause` String parameter. * `xpack.info` - Adds `human` parameter for human-readable information. @@ -39,7 +147,8 @@ Updates APIs: * `snapshot_lifecycle_management.get_status` - adds both. * `snapshot_lifecycle_management.put_lifecycle` - adds both. -APIs promoted from Experimental to Stable: +#### APIs promoted from Experimental to Stable: + * `inference.delete` * `inference.get` * `inference.inference` diff --git a/docs/release_notes/818.asciidoc b/docs/release_notes/818.asciidoc new file mode 100644 index 0000000000..c03bba4081 --- /dev/null +++ b/docs/release_notes/818.asciidoc @@ -0,0 +1,54 @@ +[[release_notes_8_18]] +=== 8.18 Release notes + +[discrete] +[[release_notes_8_18_0]] +=== 8.18.0 Release notes + +[discrete] +==== API + +New APIs: + +* `esql.async_query_stop` - Stops a previously submitted async query request given its ID and collects the results. +* `inference.chat_completion_unified` - Perform chat completion inference +* `inference.completion` - Perform completion inference +* `inference.put_alibabacloud` - Configure an AlibabaCloud AI Search inference endpoint +* `inference.put_amazonbedrock` - Configure an Amazon Bedrock inference endpoint +* `inference.put_anthropic` - Configure an Anthropic inference endpoint +* `inference.put_azureaistudio` - Configure an Azure AI Studio inference endpoint +* `inference.put_azureopenai` - Configure an Azure OpenAI inference endpoint +* `inference.put_cohere` - Configure a Cohere inference endpoint +* `inference.put_elasticsearch` - Configure an Elasticsearch inference endpoint +* `inference.put_elser` - Configure an ELSER inference endpoint +* `inference.put_googleaistudio` - Configure a Google AI Studio inference endpoint +* `inference.put_googlevertexai` - Configure a Google Vertex AI inference endpoint +* `inference.put_hugging_face` - Configure a HuggingFace inference endpoint +* `inference.put_jinaai` - Configure a JinaAI inference endpoint +* `inference.put_mistral` - Configure a Mistral inference endpoint +* `inference.put_openai` - Configure an OpenAI inference endpoint +* `inference.put_voyageai` - Configure a VoyageAI inference endpoint +* `inference.put_watsonx` - Configure a Watsonx inference endpoint +* `inference.rerank` - Perform reranking inference +* `inference.sparse_embedding` - Perform sparse embedding inference +* `inference.stream_inference` renamed to `inference.stream_completion` - Perform streaming completion inference. +* `inference.text_embedding` - Perform text embedding inference + + +Updated APIs: + +* `bulk`, `create`, `index`, `update` - Add Boolean parameter `:include_source_on_error`, if to include the document source in the error message in case of parsing errors (defaults to true). +* `cat.segments` +** Adds Boolean parameter `:local`, return local information, do not retrieve the state from master node (default: false). +** Adds Time parameter `:master_timeout`, explicit operation timeout for connection to master node. +* `cat.tasks` +** Adds Time parameter `:timeout`, period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. +** Adds Boolean parameter `:wait_for_completion`, if `true`, the request blocks until the task has completed. +* `eql.search` +** Adds Boolean parameter `:allow_partial_search_results`, control whether the query should keep running in case of shard failures, and return partial results. +** Adds Boolean parameter `:allow_partial_sequence_results`, control whether a sequence query should return partial results or no results at all in case of shard failures. This option has effect only if [allow_partial_search_results] is true. +* `index_lifecycle_management.delete_lifecycle`, `index_lifecycle_management.explain_lifecycle`, `index_lifecycle_management.get_lifecycle`, `index_lifecycle_management.put_lifecycle`, `index_lifecycle_management.start`, `index_lifecycle_management.stop`, remove `:master_timeout`, `:timeout` parameters. +* `indices.resolve_cluster` - Adds `:timeout` parameter, `:name` no longer a required parameter. +* `indices.rollover` - Removes target_failure_store parameter. +* `ingest.delete_geoip_database`, `ingest.delete_ip_location_database`, `put_geoip_database`, `put_ip_location_database` remove `:master_timeout`, `:timeout` parameters. +* `machine_learning.start_trained_model_deployment` - Adds body request parameter, the settings for the trained model deployment. diff --git a/docs/release_notes/819.asciidoc b/docs/release_notes/819.asciidoc new file mode 100644 index 0000000000..b8c70529f6 --- /dev/null +++ b/docs/release_notes/819.asciidoc @@ -0,0 +1,59 @@ +[[release_notes_8_19]] +=== 8.19 Release notes + +[discrete] +[[release_notes_8_19_0]] +=== 8.19.0 Release notes + +[discrete] +==== Client + +Tested versions of Ruby for 8.19.0: Ruby (MRI) 3.1, 3.2, 3.3, 3.4. JRuby 9.3, JRuby 9.4 and JRuby 10. + +[discrete] +==== API + +[discrete] +===== API changes + +* `cluster.get_component_template` - Adds `flat_settings` boolean parameter, return settings in flat format (default: false). Adds `settings_filter` String parameter, filter out results, for example to filter out sensitive information. +* `cluster.put_component_template` - Removes `timeout` parameter, adds `cause` String parameter, used defined reason for creation. +* `create` - Adds `require_alias` and `require_data_stream` boolean parameters, to specify required type to be created. +* `eql.search` - Adds `ccs_minimize_roundtrips`, `ignore_unavailable`, `allow_no_indices` boolean parameters and `expand_wildcards` String parameter. +* `esql.async_query` - Adds `allow_partial_results` boolean parameter. +* `esql.async_query_get` - Adds `format` String parameter (e.g. json, yaml). +* `esql.query` - Adds `allow_partial_results` boolean parameter. +* `indices.recovery` - Adds `ignore_unavailable`, `allow_no_indices` boolean parameters and `expand_wildcards` String parameter. +* `msearch` - Adds `ignore_unavailable`, `ignore_throttled`, `allow_no_indices`, `include_named_queries_score` boolean parameters, `expand_wildcards` String parameter and `routing`, a comma-separated list of specific routing values. +* `open_point_in_time` - Adds `max_concurrent_shard_requests` parameter, the number of concurrent shard requests per node executed concurrently when opening this point-in-time +* `reindex` - Adds `require_alias` boolean parameter. +* `search_mvt` - Adds `grid_agg` String parameter, aggregation used to create a grid for `field`. +* `snapshot.repository_analyze` - Adds `register_operation_count` parameter, the minimum number of linearizable register operations to perform in total. + +Time parameters `master_timeout` and `timeout` have been added to the following APIs: + +* `index_lifecycle_management`: +** `delete_lifecycle` +** `get_lifecycle` +** `put_lifecycle` +** `start` +** `stop` +** `explain_lifecycle` - Only `master_timeout` + +* `ingest`: +** `delete_geoip_database` +** `delete_ip_location_database` +** `put_geoip_database` +** `put_ip_location_database` + +[discrete] +===== New APIs + +* `indices.delete_data_stream_options` - Deletes the data stream options of the selected data streams. +* `indices.get_data_stream_options` - Returns the data stream options of the selected data streams. +* `indices.get_data_stream_settings` - Gets a data stream's settings. +* `indices.put_data_stream_options` - Updates the data stream options of the selected data streams. +* `indices.put_data_stream_settings` - Updates a data stream's settings. +* `inference.put_amazonsagemaker` - Configure an Amazon SageMaker inference endpoint. +* `inference.put_custom` - Configure a custom inference endpoint. +* `inference.put_deepseek` - Configure a DeepSeek inference endpoint. diff --git a/docs/release_notes/index.asciidoc b/docs/release_notes/index.asciidoc index 47c311cd11..ac85d25d82 100644 --- a/docs/release_notes/index.asciidoc +++ b/docs/release_notes/index.asciidoc @@ -3,6 +3,8 @@ [discrete] === 8.x +* <> +* <> * <> * <> * <> @@ -39,6 +41,8 @@ * <> * <> +include::819.asciidoc[] +include::818.asciidoc[] include::817.asciidoc[] include::816.asciidoc[] include::815.asciidoc[] diff --git a/elasticsearch-api/lib/elasticsearch/api/version.rb b/elasticsearch-api/lib/elasticsearch/api/version.rb index adfd7a85aa..f3e663412c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/version.rb +++ b/elasticsearch-api/lib/elasticsearch/api/version.rb @@ -17,6 +17,6 @@ module Elasticsearch module API - VERSION = '8.18.0'.freeze + VERSION = '8.19.0'.freeze end end diff --git a/elasticsearch/elasticsearch.gemspec b/elasticsearch/elasticsearch.gemspec index dd16a0e5f4..0c434a729f 100644 --- a/elasticsearch/elasticsearch.gemspec +++ b/elasticsearch/elasticsearch.gemspec @@ -46,7 +46,7 @@ Gem::Specification.new do |s| s.required_ruby_version = '>= 2.5' s.add_dependency 'elastic-transport', '~> 8.3' - s.add_dependency 'elasticsearch-api', '8.18.0' + s.add_dependency 'elasticsearch-api', '8.19.0' s.add_development_dependency 'base64' s.add_development_dependency 'bundler' diff --git a/elasticsearch/lib/elasticsearch/version.rb b/elasticsearch/lib/elasticsearch/version.rb index 8d7e5e7064..4826df9a6d 100644 --- a/elasticsearch/lib/elasticsearch/version.rb +++ b/elasticsearch/lib/elasticsearch/version.rb @@ -16,5 +16,5 @@ # under the License. module Elasticsearch - VERSION = '8.18.0'.freeze + VERSION = '8.19.0'.freeze end