Skip to content

Commit eef5ba0

Browse files
[8.1] Add release notes for 7.17.1
Co-authored-by: Seth Michael Larson <[email protected]>
1 parent e891c09 commit eef5ba0

File tree

1 file changed

+106
-97
lines changed

1 file changed

+106
-97
lines changed

docs/guide/release-notes.asciidoc

+106-97
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
== Release notes
33

44
* <<rn-8-0-0>>
5+
* <<rn-7-17-1>>
56
* <<rn-7-17-0>>
67
* <<rn-7-16-3>>
78
* <<rn-7-16-2>>
@@ -45,111 +46,119 @@
4546
[discrete]
4647
==== Added
4748

48-
- Added the top-level `.options()` method to `Elasticsearch` and `AsyncElasticsearch` for modifying transport options.
49-
- Added parameters corresponding to JSON request body fields for all APIs
50-
- Added `basic_auth` parameter for specifying username and password authentication
51-
- Added `bearer_auth` parameter for specifying an HTTP bearer token or service token
52-
- Added the `meta` property to `ApiError` to access the HTTP response metadata of an error.
53-
- Added a check that a compatible version of the `elastic-transport` package is installed.
49+
* Added the top-level `.options()` method to `Elasticsearch` and `AsyncElasticsearch` for modifying transport options.
50+
* Added parameters corresponding to JSON request body fields for all APIs
51+
* Added `basic_auth` parameter for specifying username and password authentication
52+
* Added `bearer_auth` parameter for specifying an HTTP bearer token or service token
53+
* Added the `meta` property to `ApiError` to access the HTTP response metadata of an error.
54+
* Added a check that a compatible version of the `elastic-transport` package is installed.
5455

5556
[discrete]
5657
==== Changed
5758

58-
- Changed the transport layer to use the `elastic-transport` package
59-
- Changed user-defined `body` parameters to have semantic names (e.g `index(document={...})` instead of `index(body={...})`).
60-
- Changed responses to be objects with two properties, `meta` for response metadata (HTTP status, headers, node, etc) and `body` for a typed body.
61-
- Changed `AsyncElasticsearch` to always be available, regardless of whether `aiohttp` is installed
62-
- Changed exception hierarchy, the major change is a new exception `ApiError` which differentiates between an error that's raised from the transport layer (previously `elasticsearch.exceptions.TransportError`, now `elastic_transport.TransportError`) and one raised from the API layer
63-
- Changed the name of `JSONSerializer` to `JsonSerializer` for consistency with other serializer names. Added an alias to the old name for backwards compatibility
64-
- Changed the default mimetypes (`application/json`) to instead use compatibility mimetypes (`application/vnd.elasticsearch+json`) which always request for responses compatibility with version 8.x.
59+
* Changed the transport layer to use the `elastic-transport` package
60+
* Changed user-defined `body` parameters to have semantic names (e.g `index(document={...})` instead of `index(body={...})`).
61+
* Changed responses to be objects with two properties, `meta` for response metadata (HTTP status, headers, node, etc) and `body` for a typed body.
62+
* Changed `AsyncElasticsearch` to always be available, regardless of whether `aiohttp` is installed
63+
* Changed exception hierarchy, the major change is a new exception `ApiError` which differentiates between an error that's raised from the transport layer (previously `elasticsearch.exceptions.TransportError`, now `elastic_transport.TransportError`) and one raised from the API layer
64+
* Changed the name of `JSONSerializer` to `JsonSerializer` for consistency with other serializer names. Added an alias to the old name for backwards compatibility
65+
* Changed the default mimetypes (`application/json`) to instead use compatibility mimetypes (`application/vnd.elasticsearch+json`) which always request for responses compatibility with version 8.x.
6566

6667
[discrete]
6768
==== Removed
6869

69-
- Removed support for Python 2.7 and Python 3.5, the library now supports only Python 3.6+
70-
- Removed the `elasticsearch.connection` module as all functionality has been moved to the `elastic-transport` package
71-
- Removed the default URL of `http://localhost:9200` due to Elasticsearch 8.0 default configuration being `https://localhost:9200`.
70+
* Removed support for Python 2.7 and Python 3.5, the library now supports only Python 3.6+
71+
* Removed the `elasticsearch.connection` module as all functionality has been moved to the `elastic-transport` package
72+
* Removed the default URL of `http://localhost:9200` due to Elasticsearch 8.0 default configuration being `https://localhost:9200`.
7273
The client's connection to Elasticsearch now must be specified with scheme, host, and port or with the `cloud_id` parameter
73-
- Removed the ability to use positional arguments with API methods. Going forward all API parameters must be keyword-only parameters
74-
- Removed the `doc_type`, `include_type_name`, and `copy_settings` parameters from many document and index APIs
74+
* Removed the ability to use positional arguments with API methods. Going forward all API parameters must be keyword-only parameters
75+
* Removed the `doc_type`, `include_type_name`, and `copy_settings` parameters from many document and index APIs
7576

7677
[discrete]
7778
==== Deprecated
7879

79-
- Deprecated the `body` and `params` parameters on all APIs
80-
- Deprecated setting transport options `http_auth`, `api_key`, `ignore`, `request_timeout`, `headers`, and `opaque_id`
80+
* Deprecated the `body` and `params` parameters on all APIs
81+
* Deprecated setting transport options `http_auth`, `api_key`, `ignore`, `request_timeout`, `headers`, and `opaque_id`
8182
All of these settings should instead be set via the `.options()` method
82-
- Deprecated the `elasticsearch.transport` and `elasticsearch.client` modules. These modules will be removed in a future version
83+
* Deprecated the `elasticsearch.transport` and `elasticsearch.client` modules. These modules will be removed in a future version
8384

8485
[discrete]
8586
==== CAT
8687

87-
- Removed the deprecated `local` parameter from the `cat.indices`, `cat.nodes`, `cat.shards` API
88-
- Removed the deprecated `allow_no_datafeeds` parameter from the `cat.ml_datafeeds` API
89-
- Removed the deprecated `allow_no_jobs` parameter from the `cat.ml_jobs` API
90-
- Removed the deprecated `size` parameter from the `cat.thread_pool` API
91-
- Added the `time` parameter to the `cat.thread_pool` API
88+
* Removed the deprecated `local` parameter from the `cat.indices`, `cat.nodes`, `cat.shards` API
89+
* Removed the deprecated `allow_no_datafeeds` parameter from the `cat.ml_datafeeds` API
90+
* Removed the deprecated `allow_no_jobs` parameter from the `cat.ml_jobs` API
91+
* Removed the deprecated `size` parameter from the `cat.thread_pool` API
92+
* Added the `time` parameter to the `cat.thread_pool` API
9293

9394
[discrete]
9495
==== Documents
9596

96-
- Removed the deprecated `size` parameter from the `delete_by_query` API
97-
- Removed the deprecated `size` parameter from the `update_by_query` API
97+
* Removed the deprecated `size` parameter from the `delete_by_query` API
98+
* Removed the deprecated `size` parameter from the `update_by_query` API
9899

99100
[discrete]
100101
==== Indices
101102

102-
- Removed the deprecated `indices.flush_synced` API
103-
- Removed the deprecated `indices.freeze` API
104-
- Removed the deprecated `indices.get_upgrade` API
105-
- Removed the deprecated `indices.upgrade` API
106-
- Removed the deprecated `indices.exist_type` API
107-
- Removed the deprecated parameter `copy_settings` from the `indices.shrink` API
108-
- Deprecated the `verbose` parameter of the `indices.segments` API
103+
* Removed the deprecated `indices.flush_synced` API
104+
* Removed the deprecated `indices.freeze` API
105+
* Removed the deprecated `indices.get_upgrade` API
106+
* Removed the deprecated `indices.upgrade` API
107+
* Removed the deprecated `indices.exist_type` API
108+
* Removed the deprecated parameter `copy_settings` from the `indices.shrink` API
109+
* Deprecated the `verbose` parameter of the `indices.segments` API
109110

110111
[discrete]
111112
==== License / X-Pack
112113

113-
- Deprecated the `accept_enterprise` parameter of the `license.get` API
114-
- Deprecated the `accept_enterprise` parameter of the `xpack.info` API
114+
* Deprecated the `accept_enterprise` parameter of the `license.get` API
115+
* Deprecated the `accept_enterprise` parameter of the `xpack.info` API
115116

116117
[discrete]
117118
==== Machine Learning
118119

119-
- Added the **experimental** `ml.infer_trained_model_deployment` API
120-
- Added the **experimental** `ml.put_trained_model_definition_part` API
121-
- Added the **experimental** `ml.put_trained_model_vocabulary` API
122-
- Added the **experimental** `ml.start_trained_model_deployment` API
123-
- Added the **experimental** `ml.stop_trained_model_deployment` API
124-
- Added the `timeout` parameter to the `ml.delete_trained_model` API
125-
- Removed the deprecated `allow_no_jobs` parameter from the `ml.close_job` API
126-
- Removed the deprecated `ml.find_text_structure` API
127-
- Removed the deprecated `allow_no_datafeeds` parameter from the `ml.get_datafeed_stats` API
128-
- Removed the deprecated `allow_no_datafeeds` parameter from the `ml.get_datafeeds` API
129-
- Removed the deprecated `allow_no_jobs` parameter from the `ml.get_job_stats` API
130-
- Removed the deprecated `allow_no_jobs` parameter from the `ml.get_jobs` API
131-
- Removed the deprecated `allow_no_jobs` parameter from the `ml.get_overall_buckets` API
120+
* Added the **experimental** `ml.infer_trained_model_deployment` API
121+
* Added the **experimental** `ml.put_trained_model_definition_part` API
122+
* Added the **experimental** `ml.put_trained_model_vocabulary` API
123+
* Added the **experimental** `ml.start_trained_model_deployment` API
124+
* Added the **experimental** `ml.stop_trained_model_deployment` API
125+
* Added the `timeout` parameter to the `ml.delete_trained_model` API
126+
* Removed the deprecated `allow_no_jobs` parameter from the `ml.close_job` API
127+
* Removed the deprecated `ml.find_text_structure` API
128+
* Removed the deprecated `allow_no_datafeeds` parameter from the `ml.get_datafeed_stats` API
129+
* Removed the deprecated `allow_no_datafeeds` parameter from the `ml.get_datafeeds` API
130+
* Removed the deprecated `allow_no_jobs` parameter from the `ml.get_job_stats` API
131+
* Removed the deprecated `allow_no_jobs` parameter from the `ml.get_jobs` API
132+
* Removed the deprecated `allow_no_jobs` parameter from the `ml.get_overall_buckets` API
132133

133134
[discrete]
134135
==== Search
135136

136-
- Added the **experimental** `knn_search` API
137+
* Added the **experimental** `knn_search` API
137138

138139
[discrete]
139140
==== Searchable Snapshots
140141

141-
- Removed the deprecated `searchable_snapshots.repository_stats` API
142+
* Removed the deprecated `searchable_snapshots.repository_stats` API
142143

143144
[discrete]
144145
==== Snapshots
145146

146-
- Changed the `snapshot.delete` API to accept multiple snapshots
147+
* Changed the `snapshot.delete` API to accept multiple snapshots
147148

148149
[discrete]
149150
==== Security
150151

151-
- Added the `security.enroll_kibana` API
152-
- Added the `security.enroll_node` API
152+
* Added the `security.enroll_kibana` API
153+
* Added the `security.enroll_node` API
154+
155+
156+
[discrete]
157+
[[rn-7-17-1]]
158+
=== 7.17.1 (2022-02-28)
159+
160+
* Fixed `AiohttpHttpConnection`` to not leak TLS connections when the socket isn't explicitly shutdown by the peer
161+
* Fixed the `from` parameter to be rewritten to `from_` when used with the `scan` and `async_scan` helpers
153162

154163

155164
[discrete]
@@ -180,7 +189,7 @@
180189
[discrete]
181190
==== Fixed
182191

183-
- Fixed issue where the `AIOHttpConnection` wouldn't log query parameters for URLs.
192+
* Fixed issue where the `AIOHttpConnection` wouldn't log query parameters for URLs.
184193

185194

186195
[discrete]
@@ -190,56 +199,56 @@
190199
[discrete]
191200
==== Deprecated
192201

193-
- Deprecated the `send_get_body_as` parameter. This parameter is no longer necessary
202+
* Deprecated the `send_get_body_as` parameter. This parameter is no longer necessary
194203
as APIs all use non-GET HTTP methods when using a body.
195-
- Removal of `body`, `params`, and other per-request parameters has been delayed beyond 8.0.0.
204+
* Removal of `body`, `params`, and other per-request parameters has been delayed beyond 8.0.0.
196205
Changed deprecation warnings to mention "future version" instead of 8.0.0.
197206

198207
[discrete]
199208
==== Fixed
200209

201-
- Fixed an issue with `unicode` HTTP headers with the urllib3 HTTP client
202-
- Fixed an issue with the `scan` helper to always set the `sort` and `scroll` parameters
210+
* Fixed an issue with `unicode` HTTP headers with the urllib3 HTTP client
211+
* Fixed an issue with the `scan` helper to always set the `sort` and `scroll` parameters
203212

204213
[discrete]
205214
==== Search
206215

207-
- Changed the `keep_alive` parameter of the `open_point_in_time` API to be required
216+
* Changed the `keep_alive` parameter of the `open_point_in_time` API to be required
208217
to reflect its required status within Elasticsearch
209-
- Added the `track_total_hits` parameter to the `search_mvt` API
218+
* Added the `track_total_hits` parameter to the `search_mvt` API
210219

211220
[discrete]
212221
==== Fleet
213222

214-
- Changed the `fleet.global_checkpoints` API from **experimental** to **stable**
215-
- Added the `fleet.search` **experimental** API
216-
- Added the `fleet.msearch` **experimental** API
223+
* Changed the `fleet.global_checkpoints` API from **experimental** to **stable**
224+
* Added the `fleet.search` **experimental** API
225+
* Added the `fleet.msearch` **experimental** API
217226

218227
[discrete]
219228
==== Indices
220229

221-
- Added the `indices.modify_data_stream` API
230+
* Added the `indices.modify_data_stream` API
222231

223232
[discrete]
224233
==== Ingest
225234

226-
- Added the `if_version` parameter to the `ingest.put_pipeline` API
235+
* Added the `if_version` parameter to the `ingest.put_pipeline` API
227236

228237
[discrete]
229238
==== Migration
230239

231-
- Added the `migration.get_feature_upgrade_status` API
232-
- Added the `migration.post_feature_upgrade` API
240+
* Added the `migration.get_feature_upgrade_status` API
241+
* Added the `migration.post_feature_upgrade` API
233242

234243
[discrete]
235244
==== Machine Learning
236245

237-
- Added the `defer_definition_decompression` parameter to the `ml.put_trained_model` API
246+
* Added the `defer_definition_decompression` parameter to the `ml.put_trained_model` API
238247

239248
[discrete]
240249
==== Transforms
241250

242-
- Added the `transform.upgrade_transforms` API
251+
* Added the `transform.upgrade_transforms` API
243252

244253

245254
[discrete]
@@ -249,7 +258,7 @@
249258
[discrete]
250259
==== Nodes
251260

252-
- Documented additional options the `metric` parameter of the `nodes.info` API.
261+
* Documented additional options the `metric` parameter of the `nodes.info` API.
253262

254263

255264
[discrete]
@@ -259,13 +268,13 @@
259268
[discrete]
260269
==== Client
261270

262-
- Fixed a performance regression in `JSONSerializer.default()` when `numpy` and `pandas` weren't installed.
263-
- Changed the `DeprecationWarning` for the `body` parameter to be a "removed in a future version" instead of "removed in 8.0" in line with the 8.0 roadmap.
271+
* Fixed a performance regression in `JSONSerializer.default()` when `numpy` and `pandas` weren't installed.
272+
* Changed the `DeprecationWarning` for the `body` parameter to be a "removed in a future version" instead of "removed in 8.0" in line with the 8.0 roadmap.
264273

265274
[discrete]
266275
==== Search
267276

268-
- The `index` parameter of the `open_point_in_time` API is now required, was optional.
277+
* The `index` parameter of the `open_point_in_time` API is now required, was optional.
269278

270279

271280
[discrete]
@@ -275,55 +284,55 @@
275284
[discrete]
276285
==== Client
277286

278-
- Added more precise type hints to many API parameters
279-
- Added explicit parameters to `AsyncTransport` and `AIOHttpConnection`
280-
- Added `MapboxVectorTileSerializer` for handling the `application/vnd.mapbox-vector-tile` mimetype. Because this mimetype is binary rather than text the raw response `bytes` are forwarded from the serializer without decoding
281-
- Reduced amount of time to import the `elasticsearch` module by delaying imports of `pandas` and `numpy` until later in the JSON serialization stage if necessary
282-
- Deprecated positional arguments for APIs, instead use keyword arguments exclusively.
287+
* Added more precise type hints to many API parameters
288+
* Added explicit parameters to `AsyncTransport` and `AIOHttpConnection`
289+
* Added `MapboxVectorTileSerializer` for handling the `application/vnd.mapbox-vector-tile` mimetype. Because this mimetype is binary rather than text the raw response `bytes` are forwarded from the serializer without decoding
290+
* Reduced amount of time to import the `elasticsearch` module by delaying imports of `pandas` and `numpy` until later in the JSON serialization stage if necessary
291+
* Deprecated positional arguments for APIs, instead use keyword arguments exclusively.
283292

284293
[discrete]
285294
==== Search
286295

287-
- Added the `search_mvt` **experimental** API
288-
- Added body field parameters to the `search`, `scroll`, and `clear_scroll` APIs
289-
- Deprecated the `body` parameter of the `search`, `scroll`, and `clear_scroll` APIs
296+
* Added the `search_mvt` **experimental** API
297+
* Added body field parameters to the `search`, `scroll`, and `clear_scroll` APIs
298+
* Deprecated the `body` parameter of the `search`, `scroll`, and `clear_scroll` APIs
290299

291300
[discrete]
292301
==== Documents
293302

294-
- Added body field parameters to the `update` API
295-
- Added the `document` parameter to the `create` and `index` APIs
296-
- Deprecated the `body` parameter of the `create`, `index`, and `update` APIs
303+
* Added body field parameters to the `update` API
304+
* Added the `document` parameter to the `create` and `index` APIs
305+
* Deprecated the `body` parameter of the `create`, `index`, and `update` APIs
297306

298307
[discrete]
299308
==== Indices
300309

301-
- Added the `indices.disk_usage` **experimental** API
302-
- Added the `indices.fields_usage_stats` **experimental** API
303-
- Added body field parameters to the `indices.create` API
304-
- Deprecated the `body` parameter of the `indices.create` API
310+
* Added the `indices.disk_usage` **experimental** API
311+
* Added the `indices.fields_usage_stats` **experimental** API
312+
* Added body field parameters to the `indices.create` API
313+
* Deprecated the `body` parameter of the `indices.create` API
305314

306315
[discrete]
307316
==== Machine Learning
308317

309-
- Added the `ignore_unavailable`, `allow_no_indices`, `ignore_throttled`, and `expand_wildcards` parameters to the `ml.put_job` API
318+
* Added the `ignore_unavailable`, `allow_no_indices`, `ignore_throttled`, and `expand_wildcards` parameters to the `ml.put_job` API
310319

311320
[discrete]
312321
==== Nodes
313322

314-
- Added the `nodes.clear_repositories_metering_archive` **experimental** API
315-
- Added the `nodes.get_repositories_metering_info` **experimental** API
316-
- Added the `shards` option to the `index_metric` parameter of the `nodes.stats` API
317-
- Deprecated the `doc_type` parameter of the `nodes.hot_threads` API, instead use the `type` parameter
323+
* Added the `nodes.clear_repositories_metering_archive` **experimental** API
324+
* Added the `nodes.get_repositories_metering_info` **experimental** API
325+
* Added the `shards` option to the `index_metric` parameter of the `nodes.stats` API
326+
* Deprecated the `doc_type` parameter of the `nodes.hot_threads` API, instead use the `type` parameter
318327
[discrete]
319328
==== Security
320329

321-
- Added the `security.query_api_keys` API
330+
* Added the `security.query_api_keys` API
322331

323332
[discrete]
324333
==== License
325334

326-
- Deprecated the `doc_type` parameter of the `license.post_start_trial` API, instead use the `type` parameter
335+
* Deprecated the `doc_type` parameter of the `license.post_start_trial` API, instead use the `type` parameter
327336

328337

329338
[discrete]

0 commit comments

Comments
 (0)