2022-10-20 11:48:53 -07:00
# CHANGELOG
Inspired from [Keep a Changelog ](https://keepachangelog.com/en/1.0.0/ )
2023-03-08 15:05:06 -05:00
## [Unreleased]
2023-03-11 08:51:20 -08:00
### Added
2023-08-02 15:00:20 -07:00
- Added generating imports and headers to API generator ([#467 ](https://github.com/opensearch-project/opensearch-py/pull/467 ))
2023-09-26 09:46:18 -07:00
- Added point-in-time APIs (create_pit, delete_pit, delete_all_pits, get_all_pits) and Security Client APIs (health and update_audit_configuration) ([#502 ](https://github.com/opensearch-project/opensearch-py/pull/502 ))
2023-10-16 15:32:17 -04:00
- Added guide on using index templates ([#531 ](https://github.com/opensearch-project/opensearch-py/pull/531 ))
2023-10-12 18:55:31 -04:00
- Added `pool_maxsize` for `Urllib3HttpConnection` ([#535 ](https://github.com/opensearch-project/opensearch-py/pull/535 ))
2023-10-13 14:29:54 -04:00
- Added benchmarks ([#537 ](https://github.com/opensearch-project/opensearch-py/pull/537 ))
2023-10-16 15:32:17 -04:00
- Added guide on making raw JSON REST requests ([#542 ](https://github.com/opensearch-project/opensearch-py/pull/542 ))
2023-10-23 19:46:19 -04:00
- Added support for AWS SigV4 for urllib3 ([#547 ](https://github.com/opensearch-project/opensearch-py/pull/547 ))
2023-10-26 07:59:07 -07:00
- Added `remote store` client APIs ([#552 ](https://github.com/opensearch-project/opensearch-py/pull/552 ))
2023-10-26 11:55:25 -04:00
- Added `nox -rs generate` ([#554 ](https://github.com/opensearch-project/opensearch-py/pull/554 ))
2023-10-26 13:34:34 -04:00
- Added a utf-8 header to all .py files ([#557 ](https://github.com/opensearch-project/opensearch-py/pull/557 ))
2023-10-26 22:55:50 -04:00
- Added `samples` , `benchmarks` and `docs` to `nox -rs format` ([#556 ](https://github.com/opensearch-project/opensearch-py/pull/556 ))
2023-10-30 20:02:30 -07:00
- Added guide on the document lifecycle API(s) ([#559 ](https://github.com/opensearch-project/opensearch-py/pull/559 ))
2023-07-26 17:19:22 -07:00
### Changed
2023-10-03 16:01:41 -07:00
- Generate `tasks` client from API specs ([#508 ](https://github.com/opensearch-project/opensearch-py/pull/508 ))
- Generate `ingest` client from API specs ([#513 ](https://github.com/opensearch-project/opensearch-py/pull/513 ))
- Generate `dangling_indices` client from API specs ([#511 ](https://github.com/opensearch-project/opensearch-py/pull/511 ))
2023-10-09 14:57:09 -07:00
- Generate `cluster` client from API specs ([#530 ](https://github.com/opensearch-project/opensearch-py/pull/530 ))
2023-10-03 16:01:41 -07:00
- Generate `nodes` client from API specs ([#514 ](https://github.com/opensearch-project/opensearch-py/pull/514 ))
2023-10-09 14:55:51 -07:00
- Generate `cat` client from API specs ([#529 ](https://github.com/opensearch-project/opensearch-py/pull/529 ))
2023-10-26 07:58:33 -07:00
- Use API generator for all APIs ([#551 ](https://github.com/opensearch-project/opensearch-py/pull/551 ))
2023-11-06 13:08:19 -05:00
- Merge `.pyi` type stubs inline ([#563 ](https://github.com/opensearch-project/opensearch-py/pull/563 ))
2023-11-09 10:51:20 -05:00
- Expanded type coverage to benchmarks, samples and tests ([#566 ](https://github.com/opensearch-project/opensearch-py/pull/566 ))
2023-07-26 17:19:22 -07:00
### Deprecated
2023-09-26 09:46:18 -07:00
- Deprecated point-in-time APIs (list_all_point_in_time, create_point_in_time, delete_point_in_time) and Security Client APIs (health_check and update_audit_config) ([#502 ](https://github.com/opensearch-project/opensearch-py/pull/502 ))
2023-07-26 17:19:22 -07:00
### Removed
2023-10-24 10:57:21 -04:00
- Removed leftover support for Python 2.7 ([#548 ](https://github.com/opensearch-project/opensearch-py/pull/548 ))
2023-07-26 17:19:22 -07:00
### Fixed
### Security
2023-07-31 10:15:36 -07:00
### Dependencies
2023-08-21 11:46:51 -07:00
- Bumps `sphinx` from <7.1 to <7.3
2023-10-06 13:37:56 -07:00
## [2.3.2]
### Added
### Changed
### Deprecated
### Removed
### Fixed
### Security
### Dependencies
- Bumps `urllib3` from >=1.21.1, <2 to >=1.26.9 ([#518 ](https://github.com/opensearch-project/opensearch-py/pull/518 ))
2023-07-26 17:19:22 -07:00
2023-08-21 12:06:19 -07:00
## [2.3.1]
### Added
### Changed
### Deprecated
### Removed
### Fixed
- Fixed race condition in AWSV4SignerAuth & AWSV4SignerAsyncAuth when using refreshable credentials ([#470 ](https://github.com/opensearch-project/opensearch-py/pull/470 ))
### Security
### Dependencies
2023-10-12 14:11:21 -07:00
- Bumps `urllib3` from >= 1.26.9 to >= 1.26.17 [#533 ](https://github.com/opensearch-project/opensearch-py/pull/533 )
2023-08-21 12:06:19 -07:00
2023-07-26 17:19:22 -07:00
## [2.3.0]
### Added
2023-03-17 12:03:46 -07:00
- Added async support for helpers that are merged from opensearch-dsl-py ([#329 ](https://github.com/opensearch-project/opensearch-py/pull/329 ))
2023-04-20 21:57:00 -05:00
- Added search.md to guides ([#356 ](https://github.com/opensearch-project/opensearch-py/pull/356 ))
2023-04-24 23:33:51 +06:00
- Added index lifecycle guide ([#362 ](https://github.com/opensearch-project/opensearch-py/pull/362 ))
2023-07-24 12:23:51 -05:00
- Added point in time APIs to the pyi files in sync and async client ([#378 ](https://github.com/opensearch-project/opensearch-py/pull/378 ))
2023-05-15 17:48:05 -04:00
- Added MacOS and Windows CI workflows ([#390 ](https://github.com/opensearch-project/opensearch-py/pull/390 ))
2023-06-27 17:01:40 +02:00
- Added support for the security plugin ([#399 ](https://github.com/opensearch-project/opensearch-py/pull/399 ))
2023-07-24 12:23:51 -05:00
- Supports OpenSearch 2.1.0 - 2.6.0 ([#381 ](https://github.com/opensearch-project/opensearch-py/pull/381 ))
- Added `allow_redirects` to `RequestsHttpConnection#perform_request` ([#401 ](https://github.com/opensearch-project/opensearch-py/pull/401 ))
2023-10-16 08:27:22 -07:00
- Enhanced YAML test runner to use OpenSearch `rest-api-spec` YAML tests ([#414 ](https://github.com/opensearch-project/opensearch-py/pull/414 ))
2023-06-27 01:19:15 +02:00
- Added `Search#collapse` ([#409 ](https://github.com/opensearch-project/opensearch-py/issues/409 ))
2023-06-28 22:56:00 +02:00
- Added support for the ISM API ([#398 ](https://github.com/opensearch-project/opensearch-py/pull/398 ))
2023-07-19 14:02:04 +01:00
- Added `trust_env` to `AIOHttpConnection` ([#398 ](https://github.com/opensearch-project/opensearch-py/pull/438 ))
2023-07-21 10:08:09 -07:00
- Added support for latest OpenSearch versions 2.7.0, 2.8.0 ([#445 ](https://github.com/opensearch-project/opensearch-py/pull/445 ))
2023-07-24 12:23:51 -05:00
- Added samples ([#447 ](https://github.com/opensearch-project/opensearch-py/pull/447 ))
- Improved CI performance of integration with unreleased OpenSearch ([#318 ](https://github.com/opensearch-project/opensearch-py/pull/318 ))
2023-07-25 21:04:13 -05:00
- Added k-NN guide and samples ([#449 ](https://github.com/opensearch-project/opensearch-py/pull/449 ))
2023-07-26 12:18:45 -05:00
- Added the ability to run tests matching a pattern to `.ci/run-tests` ([#454 ](https://github.com/opensearch-project/opensearch-py/pull/454 ))
2023-03-11 08:51:20 -08:00
### Changed
2023-07-24 12:23:51 -05:00
- Moved security from `plugins` to `clients` ([#442 ](https://github.com/opensearch-project/opensearch-py/pull/442 ))
2023-07-26 15:38:49 -07:00
- Updated Security Client APIs ([#450 ](https://github.com/opensearch-project/opensearch-py/pull/450 ))
2023-03-11 08:51:20 -08:00
### Deprecated
### Removed
2023-07-24 12:23:51 -05:00
- Removed support for Python 2.7 ([#421 ](https://github.com/opensearch-project/opensearch-py/pull/421 ))
2023-10-12 14:11:21 -07:00
- Removed support for Python 3.5 ([#533 ](https://github.com/opensearch-project/opensearch-py/pull/533 ))
2023-03-08 15:05:06 -05:00
### Fixed
2023-07-24 12:23:51 -05:00
- Fixed flaky CI tests by replacing httpbin with a simple http_server ([#395 ](https://github.com/opensearch-project/opensearch-py/pull/395 ))
2023-03-08 15:05:06 -05:00
- Fixed import cycle when importing async helpers ([#311 ](https://github.com/opensearch-project/opensearch-py/pull/311 ))
2023-07-24 12:23:51 -05:00
- Fixed `make docs` with sphinx([#433 ](https://github.com/opensearch-project/opensearch-py/pull/433 ))
- Fixed user guide for async client ([#340 ](https://github.com/opensearch-project/opensearch-py/pull/340 ))
- Include parsed error info in `TransportError` in async connections ([#226 ](https://github.com/opensearch-project/opensearch-py/pull/226 ))
2023-06-27 11:56:55 -07:00
- Enhanced existing API generator to use OpenSearch OpenAPI spec ([#412 ](https://github.com/opensearch-project/opensearch-py/pull/412 ))
2023-07-24 12:23:51 -05:00
- Fix crash when attempting to authenticate with an async connection ([#424 ](https://github.com/opensearch-project/opensearch-py/pull/424 ))
2023-09-15 10:07:52 +03:00
- Fixed poetry run command issue on Windows/Mac machines ([#494 ](https://github.com/opensearch-project/opensearch-py/pull/494 ))
2023-03-11 08:51:20 -08:00
### Security
2023-03-13 13:27:56 -07:00
- Fixed CVE-2022-23491 reported in opensearch-dsl-py ([#295 ](https://github.com/opensearch-project/opensearch-py/pull/295 ))
2023-04-24 10:34:10 -07:00
### Dependencies
2023-07-24 12:23:51 -05:00
- Bumps `pytest-asyncio` to 0.21.0 ([#339 ](https://github.com/opensearch-project/opensearch-py/pull/339 ))
2023-06-06 13:18:00 -04:00
- Bumps `sphinx` from <1.7 to <7.1
2023-07-17 13:25:27 -04:00
- Bumps `pytest-asyncio` from <=0.21.0 to <=0.21.1
2023-03-08 15:05:06 -05:00
## [2.2.0]
2022-10-20 11:48:53 -07:00
### Added
2023-07-24 12:23:51 -05:00
- Merged opensearch-dsl-py into opensearch-py ([#287 ](https://github.com/opensearch-project/opensearch-py/pull/287 ))
- Added UPGRADING.md and updated it for opensearch-py 2.2.0 release ([#293 ](https://github.com/opensearch-project/opensearch-py/pull/293 ))
2023-01-03 12:24:25 -08:00
### Changed
### Deprecated
### Removed
2023-02-21 15:34:47 -08:00
- Removed 'out/opensearchpy' folder which was produced while generating pyi files for plugins ([#288 ](https://github.com/opensearch-project/opensearch-py/pull/288 ))
2023-03-08 15:05:06 -05:00
- Removed low-level and high-level client terminology from guides ([#298 ](https://github.com/opensearch-project/opensearch-py/pull/298 ))
### Fixed
2023-07-24 12:23:51 -05:00
- Fixed CVE-2022-23491 ([#295 ](https://github.com/opensearch-project/opensearch-py/pull/295 ))
2023-03-08 15:05:06 -05:00
### Security
## [2.1.1]
### Added
### Changed
### Deprecated
### Removed
2023-01-03 12:24:25 -08:00
### Fixed
2023-01-23 19:38:31 -07:00
- Fixed SigV4 Signing for Managed Service ([#279 ](https://github.com/opensearch-project/opensearch-py/pull/279 ))
- Fixed SigV4 Signing for Async Requests with QueryStrings ([#272 ](https://github.com/opensearch-project/opensearch-py/pull/279 ))
### Security
2023-01-03 12:24:25 -08:00
2023-01-23 19:38:31 -07:00
## [2.1.0]
### Added
- Added Support for AOSS ([#268 ](https://github.com/opensearch-project/opensearch-py/pull/268 ))
### Changed
### Deprecated
### Removed
### Fixed
2023-01-03 12:24:25 -08:00
### Security
## [2.0.1]
### Added
2023-07-24 12:23:51 -05:00
- Added point in time support ([#191 ](https://github.com/opensearch-project/opensearch-py/pull/191 ))
- Added `pool_maxsize` for `RequestsHttpConnection` ([#216 ](https://github.com/opensearch-project/opensearch-py/pull/216 ))
- Added Github workflow for CHANGELOG verification ([#218 ](https://github.com/opensearch-project/opensearch-py/pull/218 ))
- Added overload decorators to `helpers-actions.pyi-bulk` ([#239 ](https://github.com/opensearch-project/opensearch-py/pull/239 ))
- Documented Keberos authentication ([214 ](https://github.com/opensearch-project/opensearch-py/pull/214 ))
- Added release workflows ([#240 ](https://github.com/opensearch-project/opensearch-py/pull/240 ))
- Added SigV4 support for async ([#254 ](https://github.com/opensearch-project/opensearch-py/pull/254 ))
2023-01-05 15:46:52 -08:00
- Compatibility with OpenSearch 2.1.0 - 2.4.1 ([#257 ](https://github.com/opensearch-project/opensearch-py/pull/257 ))
2023-07-24 12:23:51 -05:00
- Added explicit parameters for `AIOHttpConnection` and `AsyncTransport` ([#276 ](https://github.com/opensearch-project/opensearch-py/pull/276 ))
- Added support for a custom signing service name for AWS SigV4 ([#268 ](https://github.com/opensearch-project/opensearch-py/pull/268 ))
2022-10-20 11:48:53 -07:00
### Changed
2023-07-24 12:23:51 -05:00
- Updated getting started in user guide ([#233 ](https://github.com/opensearch-project/opensearch-py/pull/233 ))
2022-11-22 11:33:45 -05:00
- Updated CA certificate handling to check OpenSSL environment variables before defaulting to certifi ([#196 ](https://github.com/opensearch-project/opensearch-py/pull/196 ))
2023-07-24 12:23:51 -05:00
- Updated `master` to `cluster_manager` to be inclusive ([#242 ](https://github.com/opensearch-project/opensearch-py/pull/242 ))
2023-01-19 15:20:19 -08:00
- Updated CI tests to make them work locally ([#275 ](https://github.com/opensearch-project/opensearch-py/pull/275 ))
2023-07-24 12:23:51 -05:00
- Fixed bug with validation of `timeout` ([#387 ](https://github.com/opensearch-project/opensearch-py/issues/387 ))
2022-10-20 11:48:53 -07:00
### Deprecated
### Removed
2023-01-08 09:10:37 -08:00
- Removed patch versions in integration tests for OpenSearch 1.0.0 - 2.3.0 to reduce Github Action jobs ([#262 ](https://github.com/opensearch-project/opensearch-py/pull/262 ))
2022-10-20 11:48:53 -07:00
### Fixed
2022-12-01 19:26:24 +00:00
- Fixed DeprecationWarning emitted from urllib3 1.26.13+ ([#246 ](https://github.com/opensearch-project/opensearch-py/pull/246 ))
2023-10-03 20:15:35 +05:30
- Fixed Wrong return type hint in `async_scan` ([520 ](https://github.com/opensearch-project/opensearch-py/pull/520 ))
2022-10-20 11:48:53 -07:00
### Security
2023-10-06 13:37:56 -07:00
[Unreleased]: https://github.com/opensearch-project/opensearch-py/compare/v2.3.2...HEAD
2023-03-11 08:51:20 -08:00
[2.0.1]: https://github.com/opensearch-project/opensearch-py/compare/v2.0.0...v2.0.1
[2.1.0]: https://github.com/opensearch-project/opensearch-py/compare/v2.0.1...v2.1.0
[2.1.1]: https://github.com/opensearch-project/opensearch-py/compare/v2.1.0...v2.1.1
2023-08-02 14:46:49 -07:00
[2.2.0]: https://github.com/opensearch-project/opensearch-py/compare/v2.1.1...v2.2.0
2023-08-21 12:06:19 -07:00
[2.3.0]: https://github.com/opensearch-project/opensearch-py/compare/v2.2.0...v2.3.0
[2.3.1]: https://github.com/opensearch-project/opensearch-py/compare/v2.3.0...v2.3.1
2023-10-16 08:27:22 -07:00
[2.3.2]: https://github.com/opensearch-project/opensearch-py/compare/v2.3.1...v2.3.2