From 6994fea54a591a8f77630826756d3b492ba0719e Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Fri, 18 Apr 2025 15:18:25 +0400 Subject: [PATCH 1/9] Add breaking changes to release notes --- docs/release-notes/breaking-changes.md | 36 +++++++++--- docs/release-notes/index.md | 81 ++++++++++++++------------ 2 files changed, 74 insertions(+), 43 deletions(-) diff --git a/docs/release-notes/breaking-changes.md b/docs/release-notes/breaking-changes.md index 1d90c89dc..024a1ab79 100644 --- a/docs/release-notes/breaking-changes.md +++ b/docs/release-notes/breaking-changes.md @@ -14,11 +14,33 @@ Breaking changes can impact your Elastic applications, potentially disrupting no % **Action**
Steps for mitigating deprecation impact. % :::: -% ## 9.0.0 [elasticsearch-python-client-900-breaking-changes] +## 9.0.0 [elasticsearch-python-client-900-breaking-changes] -% ::::{dropdown} Title of breaking change -% Description of the breaking change. -% For more information, check [PR #](PR link). -% **Impact**
Impact of the breaking change. -% **Action**
Steps for mitigating deprecation impact. -% :::: \ No newline at end of file +::::{dropdown} Remove deprecated `Elasticsearch()` options +The `timeout`, `randomize_hosts`, `host_info_callback`, `sniffer_timeout`, `sniff_on_connection_fail` and `maxsize` parameters were deprecated in elasticsearch-py 8.0 and are now removed from `Elasticsearch.__init__()`. +For more information, check [PR #2840](https://github.com/elastic/elasticsearch-py/pull/2840). +**Impact**
These parameters were removed in favor of more descriptive versions. Using any of those parameters will prevent instantiating the Elasticsearch client. +**Action**
Those parameters can be replaced as follows: + * `timeout` is now `request_timeout` + * `randomize_hosts` is now `randomize_nodes_in_pool` + * `host_info_callback` is now `sniffed_node_callback` + * `sniffer_timeout` is now `min_delay_between_sniffing` + * `sniff_on_connection_fail` is now `sniff_on_node_failure` + * `maxsize` is now `connection_per_node` +:::: + +::::{dropdown} Remove deprecated `url_prefix` and `use_ssl` host keys +When instantiating a new client, `hosts` can be specified as a dictionary. The `url_prefix` and `use_ssl` keys are no longer allowed. +For more information, check [PR #2797](https://github.com/elastic/elasticsearch-py/pull/2797). +**Impact**
Using any of those parameters will prevent instantiating the Elasticsearch client. +**Action**
The parameters can be replaced as follows: + * `use_ssl` isn't needed as a scheme is required since elasticsearch-py 8.0 (`http` or `https`) + * `url_prefix` should be replaced with `path_prefix`, which is more descriptive. Indeed, this functionality allows deploying Elasticsearch under a specific path, such as `http://host:port/path/to/elasticsearch`, instead of the default root path (`http://host:port/`) +:::: + +::::{dropdown} Removed APIs +Elasticsearch 9 removed the kNN search and Unfreeze index APIs. +**Action**
+ * The kNN search API has been replaced by the `knn` option in the search API since Elasticsearch 8.4. + * The Unfreeze index API was deprecated in Elasticsearch 7.14, and has been removed in Elasticsearch 9 since it is not possible to freeze an index since Elasticsearch 8.0. + :::: \ No newline at end of file diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md index 5d47dd45b..7bd673c82 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -21,8 +21,15 @@ To check for security updates, go to [Security announcements for the Elastic sta ## 9.0.0 (2025-04-15) [elasticsearch-python-client-900-release-notes] +### Breaking changes + * Remove deprecated `Elasticsearch()` options ([#2840](https://github.com/elastic/elasticsearch-py/pull/2840)) * Remove deprecated `url_prefix` and `use_ssl` options ([#2797](https://github.com/elastic/elasticsearch-py/pull/2797)) + +See the breaking changes page for more details. + +### Enhancements + * Merge `Elasticsearch-DSL `_ package ([#2736](https://github.com/elastic/elasticsearch-py/pull/2736)) * Add Python DSL documentation ([#2761](https://github.com/elastic/elasticsearch-py/pull/2761)) * Autogenerate DSL field classes from schema ([#2780](https://github.com/elastic/elasticsearch-py/pull/2780)) @@ -32,42 +39,44 @@ To check for security updates, go to [Security announcements for the Elastic sta * Document use of sub-clients ([#2798](https://github.com/elastic/elasticsearch-py/pull/2798)) * Document how to making API calls ([#2843](https://github.com/elastic/elasticsearch-py/pull/2843)) * Fix `simulate` sub-client documentation ([#2749](https://github.com/elastic/elasticsearch-py/pull/2749)) -* Update APIs - * Remove deprecated `/_knn_search` API - * Remove Unfreeze an index API - * Remove min_compatible_shard_node from Search and Async Search Submit APIs - * Remove local parameter from cat alias, Alias exists, and Get alias APIs - * Remove `verbose` from Index segments API - * Remove `include_model_definition` from Get trained model configuration info API - * Remove `wait_for_active_shards` from experimental Get field usage stats API - * Support soft-deletes in connectors: - * Add `hard` to Delete connector API - * Add `include_deleted` to Get and List Connector APIs - * Add `master_timeout` to Migrate to data tiers routing APIs - * Add `master_timeout` to the Alias exists and Get alias APIs. - * Add `expand_wildcards` to Create snapshot API - * Rename incorrect `access_token` to `token` in Logout of OpenID Connect API - * Add inference APIs: Alibaba Cloud AI Search, Amazon Bedrock, Anthropic, Azure AI Studio, Azure OpenAI, Cohere, Elastic Inference Service (EIS), Elasticsearch, ELSER, Google AI Studio, Google Vertex AI, Hugging Face, Jina AI, Mistral, OpenAI, and Voyage AI - * Add Elastic Inference Service (EIS) chat completion API - * Add Reindex legacy backing indices APIs - * Add Create an index from a source index API - * Add `include_source_on_error` to Create, Index, Update and Bulk APIs - * Add Stop async ES|QL query API - * Add `timeout` to Resolve Cluster API - * Add `adaptive_allocations` body field to Start and Update a trained model deployment API - * Rename `index_template_subtitutions` to `index_template_substitutions` in Simulate data ingestion API* Add `if_primary_term`, `if_seq_no`, `op_type`, `require_alias` and `require_data_stream` to Create API - * Add `max_concurrent_shard_requests` to Open point in time API - * Add `local` and `flat_settings` to Check index templates API - * Add `reopen` to Update index settings API - * Add `resource` to Reload search analyzer API - * Add `lazy` to Roll over to a new index API - * Add `cause` and `create` to Simulate index template APIs - * Add Elastic Inference Service (EIS) chat completion - * Add inference APIs: Alibaba Cloud AI Search, Amazon Bedrock, Anthropic, Azure AI Studio, Azure OpenAI, Cohere, Elastic Inference Service (EIS), Elasticsearch, ELSER, Google AI Studio, Google Vertex AI, Hugging Face, Jina AI, Mistral, OpenAI, and Voyage AI -* Update DSL - * Add `ignore_malformed`, `script`, `on_script_error` and `time_series_dimension` to Boolean field - * Add `index` to GeoShape field - * Add `search_inference_id` to SemanticText field + +### APIs + +* Remove deprecated `/_knn_search` API +* Remove Unfreeze an index API +* Remove min_compatible_shard_node from Search and Async Search Submit APIs +* Remove local parameter from cat alias, Alias exists, and Get alias APIs +* Remove `verbose` from Index segments API +* Remove `include_model_definition` from Get trained model configuration info API +* Remove `wait_for_active_shards` from experimental Get field usage stats API +* Support soft-deletes in connectors: + * Add `hard` to Delete connector API + * Add `include_deleted` to Get and List Connector APIs +* Add `master_timeout` to Migrate to data tiers routing APIs +* Add `master_timeout` to the Alias exists and Get alias APIs. +* Add `expand_wildcards` to Create snapshot API +* Rename incorrect `access_token` to `token` in Logout of OpenID Connect API +* Add inference APIs: Alibaba Cloud AI Search, Amazon Bedrock, Anthropic, Azure AI Studio,Azure OpenAI, Cohere, Elastic Inference Service (EIS), Elasticsearch, ELSER, Google AIStudio, Google Vertex AI, Hugging Face, Jina AI, Mistral, OpenAI, and Voyage AI +* Add Elastic Inference Service (EIS) chat completion API +* Add Reindex legacy backing indices APIs +* Add Create an index from a source index API +* Add `include_source_on_error` to Create, Index, Update and Bulk APIs +* Add Stop async ES|QL query API +* Add `timeout` to Resolve Cluster API +* Add `adaptive_allocations` body field to Start and Update a trained model deployment API +* Rename `index_template_subtitutions` to `index_template_substitutions` in Simulate dataingestion API* Add `if_primary_term`, `if_seq_no`, `op_type`, `require_alias` and `require_data_stream` to Create API +* Add `max_concurrent_shard_requests` to Open point in time API +* Add `local` and `flat_settings` to Check index templates API +* Add `reopen` to Update index settings API +* Add `resource` to Reload search analyzer API +* Add `lazy` to Roll over to a new index API +* Add `cause` and `create` to Simulate index template APIs +* Add inference APIs: Alibaba Cloud AI Search, Amazon Bedrock, Anthropic, Azure AI Studio,Azure OpenAI, Cohere, Elasticsearch, ELSER, Google AIStudio, Google Vertex AI, Hugging Face, Jina AI, Mistral, OpenAI, and Voyage AI + +### DSL + * Add `ignore_malformed`, `script`, `on_script_error` and `time_series_dimension` to Boolean field + * Add `index` to GeoShape field + * Add `search_inference_id` to SemanticText field ### Features and enhancements [elasticsearch-python-client-900-features-enhancements] From 6d18b2c0c88d2e45ffc4aafa1a0fefecf0f81b0f Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Fri, 18 Apr 2025 15:22:38 +0400 Subject: [PATCH 2/9] Add upgrade tip --- docs/release-notes/index.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md index 7bd673c82..47675c1bd 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -21,6 +21,11 @@ To check for security updates, go to [Security announcements for the Elastic sta ## 9.0.0 (2025-04-15) [elasticsearch-python-client-900-release-notes] +:::{tip} +Upgrade to Elasticsearch 9 before using elasticsearch-py 9.0.0 or later. Using elasticsearch-py 9.0.0 on an Elasticsearch 8 server will fail. +Since language clients are forward-compatible, you should first upgrade Elasticsearch, then the Elasticsearch client. See the [compatibility documentation](https://www.elastic.co/docs/reference/elasticsearch/clients/python#_compatibility) for more details. +::: + ### Breaking changes * Remove deprecated `Elasticsearch()` options ([#2840](https://github.com/elastic/elasticsearch-py/pull/2840)) From 7625be7bc002ce4aae6f5c27d6a5c78b78f5da13 Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Fri, 18 Apr 2025 15:23:11 +0400 Subject: [PATCH 3/9] Update docs/release-notes/index.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/release-notes/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md index 47675c1bd..414f89487 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -76,7 +76,7 @@ See the breaking changes page for more details. * Add `resource` to Reload search analyzer API * Add `lazy` to Roll over to a new index API * Add `cause` and `create` to Simulate index template APIs -* Add inference APIs: Alibaba Cloud AI Search, Amazon Bedrock, Anthropic, Azure AI Studio,Azure OpenAI, Cohere, Elasticsearch, ELSER, Google AIStudio, Google Vertex AI, Hugging Face, Jina AI, Mistral, OpenAI, and Voyage AI +* Add inference APIs: Alibaba Cloud AI Search, Amazon Bedrock, Anthropic, Azure AI Studio, Azure OpenAI, Cohere, Elasticsearch, ELSER, Google AI Studio, Google Vertex AI, Hugging Face, Jina AI, Mistral, OpenAI, and Voyage AI ### DSL * Add `ignore_malformed`, `script`, `on_script_error` and `time_series_dimension` to Boolean field From f5573a162dfa0f0738ea5268fc322b6d25d4205c Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Fri, 18 Apr 2025 15:25:27 +0400 Subject: [PATCH 4/9] Fix impact/action formatting --- docs/release-notes/breaking-changes.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/breaking-changes.md b/docs/release-notes/breaking-changes.md index 024a1ab79..2a0c80603 100644 --- a/docs/release-notes/breaking-changes.md +++ b/docs/release-notes/breaking-changes.md @@ -32,14 +32,19 @@ For more information, check [PR #2840](https://github.com/elastic/elasticsearch- ::::{dropdown} Remove deprecated `url_prefix` and `use_ssl` host keys When instantiating a new client, `hosts` can be specified as a dictionary. The `url_prefix` and `use_ssl` keys are no longer allowed. For more information, check [PR #2797](https://github.com/elastic/elasticsearch-py/pull/2797). -**Impact**
Using any of those parameters will prevent instantiating the Elasticsearch client. -**Action**
The parameters can be replaced as follows: + +**Impact**
+Using any of those parameters will prevent instantiating the Elasticsearch client. + +**Action**
+The parameters can be replaced as follows: * `use_ssl` isn't needed as a scheme is required since elasticsearch-py 8.0 (`http` or `https`) * `url_prefix` should be replaced with `path_prefix`, which is more descriptive. Indeed, this functionality allows deploying Elasticsearch under a specific path, such as `http://host:port/path/to/elasticsearch`, instead of the default root path (`http://host:port/`) :::: ::::{dropdown} Removed APIs Elasticsearch 9 removed the kNN search and Unfreeze index APIs. + **Action**
* The kNN search API has been replaced by the `knn` option in the search API since Elasticsearch 8.4. * The Unfreeze index API was deprecated in Elasticsearch 7.14, and has been removed in Elasticsearch 9 since it is not possible to freeze an index since Elasticsearch 8.0. From a566f431798dda8d1012291bc7ed635ddb7d04fe Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Fri, 18 Apr 2025 16:37:45 +0400 Subject: [PATCH 5/9] Fix links --- docs/release-notes/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md index 414f89487..9137a71a8 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -23,7 +23,7 @@ To check for security updates, go to [Security announcements for the Elastic sta :::{tip} Upgrade to Elasticsearch 9 before using elasticsearch-py 9.0.0 or later. Using elasticsearch-py 9.0.0 on an Elasticsearch 8 server will fail. -Since language clients are forward-compatible, you should first upgrade Elasticsearch, then the Elasticsearch client. See the [compatibility documentation](https://www.elastic.co/docs/reference/elasticsearch/clients/python#_compatibility) for more details. +Since language clients are forward-compatible, you should first upgrade Elasticsearch, then the Elasticsearch client. See the [compatibility documentation](/reference/index.md#_compatibility) for more details. ::: ### Breaking changes @@ -31,7 +31,7 @@ Since language clients are forward-compatible, you should first upgrade Elastics * Remove deprecated `Elasticsearch()` options ([#2840](https://github.com/elastic/elasticsearch-py/pull/2840)) * Remove deprecated `url_prefix` and `use_ssl` options ([#2797](https://github.com/elastic/elasticsearch-py/pull/2797)) -See the breaking changes page for more details. +See the [breaking changes page](breaking-changes.md) for more details. ### Enhancements From ecdc69b5dc151f083510b93d9797fcea13058a57 Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Mon, 28 Apr 2025 16:15:34 +0400 Subject: [PATCH 6/9] Apply suggestions from code review Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> --- docs/release-notes/breaking-changes.md | 12 ++++++------ docs/release-notes/index.md | 11 ++++++----- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/release-notes/breaking-changes.md b/docs/release-notes/breaking-changes.md index 2a0c80603..100056f5b 100644 --- a/docs/release-notes/breaking-changes.md +++ b/docs/release-notes/breaking-changes.md @@ -29,23 +29,23 @@ For more information, check [PR #2840](https://github.com/elastic/elasticsearch- * `maxsize` is now `connection_per_node` :::: -::::{dropdown} Remove deprecated `url_prefix` and `use_ssl` host keys +::::{dropdown} Remove deprecated url_prefix and use_ssl host keys When instantiating a new client, `hosts` can be specified as a dictionary. The `url_prefix` and `use_ssl` keys are no longer allowed. For more information, check [PR #2797](https://github.com/elastic/elasticsearch-py/pull/2797). **Impact**
-Using any of those parameters will prevent instantiating the Elasticsearch client. +Using any of these parameters will prevent instantiating the Elasticsearch client. **Action**
The parameters can be replaced as follows: - * `use_ssl` isn't needed as a scheme is required since elasticsearch-py 8.0 (`http` or `https`) - * `url_prefix` should be replaced with `path_prefix`, which is more descriptive. Indeed, this functionality allows deploying Elasticsearch under a specific path, such as `http://host:port/path/to/elasticsearch`, instead of the default root path (`http://host:port/`) + * `use_ssl` isn't needed, as a scheme is required since elasticsearch-py 8.0 (`http` or `https`) + * `url_prefix` should be replaced with `path_prefix`, which is more descriptive. This functionality allows you to deploy Elasticsearch under a specific path, such as `http://host:port/path/to/elasticsearch`, instead of the default root path (`http://host:port/`) :::: -::::{dropdown} Removed APIs +::::{dropdown} Remove APIs Elasticsearch 9 removed the kNN search and Unfreeze index APIs. **Action**
* The kNN search API has been replaced by the `knn` option in the search API since Elasticsearch 8.4. - * The Unfreeze index API was deprecated in Elasticsearch 7.14, and has been removed in Elasticsearch 9 since it is not possible to freeze an index since Elasticsearch 8.0. + * The Unfreeze index API was deprecated in Elasticsearch 7.14 and has been removed in Elasticsearch 9. :::: \ No newline at end of file diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md index 9137a71a8..bd5c8d2f6 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -35,21 +35,21 @@ See the [breaking changes page](breaking-changes.md) for more details. ### Enhancements -* Merge `Elasticsearch-DSL `_ package ([#2736](https://github.com/elastic/elasticsearch-py/pull/2736)) +* Merge [`elasticsearch-dsl-py`](https://github.com/elastic/elasticsearch-dsl-py/) _ package ([#2736](https://github.com/elastic/elasticsearch-py/pull/2736)) * Add Python DSL documentation ([#2761](https://github.com/elastic/elasticsearch-py/pull/2761)) * Autogenerate DSL field classes from schema ([#2780](https://github.com/elastic/elasticsearch-py/pull/2780)) * Improve DSL documentation examples with class-based queries and type hints ([#2857](https://github.com/elastic/elasticsearch-py/pull/2857)) * Document the use of `param()` in Python DSL methods ([#2861](https://github.com/elastic/elasticsearch-py/pull/2861)) * Migrate documentation from AsciiDoc to Markdown format ([#2806](https://github.com/elastic/elasticsearch-py/pull/2806)) * Document use of sub-clients ([#2798](https://github.com/elastic/elasticsearch-py/pull/2798)) -* Document how to making API calls ([#2843](https://github.com/elastic/elasticsearch-py/pull/2843)) +* Document how to make API calls ([#2843](https://github.com/elastic/elasticsearch-py/pull/2843)) * Fix `simulate` sub-client documentation ([#2749](https://github.com/elastic/elasticsearch-py/pull/2749)) ### APIs * Remove deprecated `/_knn_search` API * Remove Unfreeze an index API -* Remove min_compatible_shard_node from Search and Async Search Submit APIs +* Remove `min_compatible_shard_node` from Search and Async Search Submit APIs * Remove local parameter from cat alias, Alias exists, and Get alias APIs * Remove `verbose` from Index segments API * Remove `include_model_definition` from Get trained model configuration info API @@ -61,7 +61,7 @@ See the [breaking changes page](breaking-changes.md) for more details. * Add `master_timeout` to the Alias exists and Get alias APIs. * Add `expand_wildcards` to Create snapshot API * Rename incorrect `access_token` to `token` in Logout of OpenID Connect API -* Add inference APIs: Alibaba Cloud AI Search, Amazon Bedrock, Anthropic, Azure AI Studio,Azure OpenAI, Cohere, Elastic Inference Service (EIS), Elasticsearch, ELSER, Google AIStudio, Google Vertex AI, Hugging Face, Jina AI, Mistral, OpenAI, and Voyage AI +* Add inference APIs: Alibaba Cloud AI Search, Amazon Bedrock, Anthropic, Azure AI Studio, Azure OpenAI, Cohere, Elastic Inference Service (EIS), Elasticsearch, ELSER, Google AI Studio, Google Vertex AI, Hugging Face, Jina AI, Mistral, OpenAI, and Voyage AI * Add Elastic Inference Service (EIS) chat completion API * Add Reindex legacy backing indices APIs * Add Create an index from a source index API @@ -69,7 +69,8 @@ See the [breaking changes page](breaking-changes.md) for more details. * Add Stop async ES|QL query API * Add `timeout` to Resolve Cluster API * Add `adaptive_allocations` body field to Start and Update a trained model deployment API -* Rename `index_template_subtitutions` to `index_template_substitutions` in Simulate dataingestion API* Add `if_primary_term`, `if_seq_no`, `op_type`, `require_alias` and `require_data_stream` to Create API +* Rename `index_template_subtitutions` to `index_template_substitutions` in Simulate data ingestion API +* Add `if_primary_term`, `if_seq_no`, `op_type`, `require_alias` and `require_data_stream` to Create API * Add `max_concurrent_shard_requests` to Open point in time API * Add `local` and `flat_settings` to Check index templates API * Add `reopen` to Update index settings API From a5de17f57c1343c7de97b79227ee3338a27aac89 Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Mon, 28 Apr 2025 16:17:25 +0400 Subject: [PATCH 7/9] Apply suggestions from code review Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> --- docs/release-notes/breaking-changes.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/breaking-changes.md b/docs/release-notes/breaking-changes.md index 100056f5b..a20119b6f 100644 --- a/docs/release-notes/breaking-changes.md +++ b/docs/release-notes/breaking-changes.md @@ -19,8 +19,10 @@ Breaking changes can impact your Elastic applications, potentially disrupting no ::::{dropdown} Remove deprecated `Elasticsearch()` options The `timeout`, `randomize_hosts`, `host_info_callback`, `sniffer_timeout`, `sniff_on_connection_fail` and `maxsize` parameters were deprecated in elasticsearch-py 8.0 and are now removed from `Elasticsearch.__init__()`. For more information, check [PR #2840](https://github.com/elastic/elasticsearch-py/pull/2840). -**Impact**
These parameters were removed in favor of more descriptive versions. Using any of those parameters will prevent instantiating the Elasticsearch client. -**Action**
Those parameters can be replaced as follows: + +**Impact**
These parameters were removed in favor of more descriptive versions. Using any of these parameters will prevent instantiating the Elasticsearch client. + +**Action**
These parameters can be replaced as follows: * `timeout` is now `request_timeout` * `randomize_hosts` is now `randomize_nodes_in_pool` * `host_info_callback` is now `sniffed_node_callback` From 827094dbd126b9cc82a97a171ec86d5b967391d9 Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Mon, 28 Apr 2025 16:18:04 +0400 Subject: [PATCH 8/9] Update docs/release-notes/breaking-changes.md Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> --- docs/release-notes/breaking-changes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release-notes/breaking-changes.md b/docs/release-notes/breaking-changes.md index a20119b6f..640a57036 100644 --- a/docs/release-notes/breaking-changes.md +++ b/docs/release-notes/breaking-changes.md @@ -16,7 +16,7 @@ Breaking changes can impact your Elastic applications, potentially disrupting no ## 9.0.0 [elasticsearch-python-client-900-breaking-changes] -::::{dropdown} Remove deprecated `Elasticsearch()` options +::::{dropdown} Remove deprecated Elasticsearch() options The `timeout`, `randomize_hosts`, `host_info_callback`, `sniffer_timeout`, `sniff_on_connection_fail` and `maxsize` parameters were deprecated in elasticsearch-py 8.0 and are now removed from `Elasticsearch.__init__()`. For more information, check [PR #2840](https://github.com/elastic/elasticsearch-py/pull/2840). From f13ee1314baaa1fc386fa8f5f603e1f052f95e20 Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Mon, 28 Apr 2025 16:19:13 +0400 Subject: [PATCH 9/9] Remove empty sections --- docs/release-notes/index.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md index bd5c8d2f6..fc0847d11 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -83,7 +83,3 @@ See the [breaking changes page](breaking-changes.md) for more details. * Add `ignore_malformed`, `script`, `on_script_error` and `time_series_dimension` to Boolean field * Add `index` to GeoShape field * Add `search_inference_id` to SemanticText field - -### Features and enhancements [elasticsearch-python-client-900-features-enhancements] - -### Fixes [elasticsearch-python-client-900-fixes]