Skip to content

Commit ecdc69b

Browse files
pquentinmarciw
andauthored
Apply suggestions from code review
Co-authored-by: Marci W <333176+marciw@users.noreply.github.com>
1 parent a566f43 commit ecdc69b

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

docs/release-notes/breaking-changes.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,23 @@ For more information, check [PR #2840](https://github.com/elastic/elasticsearch-
2929
* `maxsize` is now `connection_per_node`
3030
::::
3131

32-
::::{dropdown} Remove deprecated `url_prefix` and `use_ssl` host keys
32+
::::{dropdown} Remove deprecated url_prefix and use_ssl host keys
3333
When instantiating a new client, `hosts` can be specified as a dictionary. The `url_prefix` and `use_ssl` keys are no longer allowed.
3434
For more information, check [PR #2797](https://github.com/elastic/elasticsearch-py/pull/2797).
3535

3636
**Impact**<br>
37-
Using any of those parameters will prevent instantiating the Elasticsearch client.
37+
Using any of these parameters will prevent instantiating the Elasticsearch client.
3838

3939
**Action**<br>
4040
The parameters can be replaced as follows:
41-
* `use_ssl` isn't needed as a scheme is required since elasticsearch-py 8.0 (`http` or `https`)
42-
* `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/`)
41+
* `use_ssl` isn't needed, as a scheme is required since elasticsearch-py 8.0 (`http` or `https`)
42+
* `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/`)
4343
::::
4444

45-
::::{dropdown} Removed APIs
45+
::::{dropdown} Remove APIs
4646
Elasticsearch 9 removed the kNN search and Unfreeze index APIs.
4747

4848
**Action**<br>
4949
* The kNN search API has been replaced by the `knn` option in the search API since Elasticsearch 8.4.
50-
* 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.
50+
* The Unfreeze index API was deprecated in Elasticsearch 7.14 and has been removed in Elasticsearch 9.
5151
::::

docs/release-notes/index.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,21 @@ See the [breaking changes page](breaking-changes.md) for more details.
3535

3636
### Enhancements
3737

38-
* Merge `Elasticsearch-DSL <https://github.com/elastic/elasticsearch-dsl-py/>`_ package ([#2736](https://github.com/elastic/elasticsearch-py/pull/2736))
38+
* Merge [`elasticsearch-dsl-py`](https://github.com/elastic/elasticsearch-dsl-py/) _ package ([#2736](https://github.com/elastic/elasticsearch-py/pull/2736))
3939
* Add Python DSL documentation ([#2761](https://github.com/elastic/elasticsearch-py/pull/2761))
4040
* Autogenerate DSL field classes from schema ([#2780](https://github.com/elastic/elasticsearch-py/pull/2780))
4141
* Improve DSL documentation examples with class-based queries and type hints ([#2857](https://github.com/elastic/elasticsearch-py/pull/2857))
4242
* Document the use of `param()` in Python DSL methods ([#2861](https://github.com/elastic/elasticsearch-py/pull/2861))
4343
* Migrate documentation from AsciiDoc to Markdown format ([#2806](https://github.com/elastic/elasticsearch-py/pull/2806))
4444
* Document use of sub-clients ([#2798](https://github.com/elastic/elasticsearch-py/pull/2798))
45-
* Document how to making API calls ([#2843](https://github.com/elastic/elasticsearch-py/pull/2843))
45+
* Document how to make API calls ([#2843](https://github.com/elastic/elasticsearch-py/pull/2843))
4646
* Fix `simulate` sub-client documentation ([#2749](https://github.com/elastic/elasticsearch-py/pull/2749))
4747

4848
### APIs
4949

5050
* Remove deprecated `/_knn_search` API
5151
* Remove Unfreeze an index API
52-
* Remove min_compatible_shard_node from Search and Async Search Submit APIs
52+
* Remove `min_compatible_shard_node` from Search and Async Search Submit APIs
5353
* Remove local parameter from cat alias, Alias exists, and Get alias APIs
5454
* Remove `verbose` from Index segments API
5555
* Remove `include_model_definition` from Get trained model configuration info API
@@ -61,15 +61,16 @@ See the [breaking changes page](breaking-changes.md) for more details.
6161
* Add `master_timeout` to the Alias exists and Get alias APIs.
6262
* Add `expand_wildcards` to Create snapshot API
6363
* Rename incorrect `access_token` to `token` in Logout of OpenID Connect API
64-
* 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
64+
* 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
6565
* Add Elastic Inference Service (EIS) chat completion API
6666
* Add Reindex legacy backing indices APIs
6767
* Add Create an index from a source index API
6868
* Add `include_source_on_error` to Create, Index, Update and Bulk APIs
6969
* Add Stop async ES|QL query API
7070
* Add `timeout` to Resolve Cluster API
7171
* Add `adaptive_allocations` body field to Start and Update a trained model deployment API
72-
* 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
72+
* Rename `index_template_subtitutions` to `index_template_substitutions` in Simulate data ingestion API
73+
* Add `if_primary_term`, `if_seq_no`, `op_type`, `require_alias` and `require_data_stream` to Create API
7374
* Add `max_concurrent_shard_requests` to Open point in time API
7475
* Add `local` and `flat_settings` to Check index templates API
7576
* Add `reopen` to Update index settings API

0 commit comments

Comments
 (0)