opensearch-pyd/CHANGELOG.md

CHANGELOG

Inspired from Keep a Changelog

Unreleased

Added

• Added pylint line-too-long and invalid-name (#590)
• Added pylint pointless-statement (#611)
• Added a log collection guide (#579)
• Added GHA release (#614)

Changed

Deprecated

Removed

• Removed unnecessary # -*- coding: utf-8 -*- headers from .py files (#615)

Fixed

Security

2.4.2

Added

Changed

Deprecated

Removed

Fixed

• Fix TypeError on parallel_bulk (#601)
• Fix Amazon OpenSearch Serverless integration with LangChain (#603)
• Fix type of Field.__setattr__ (604)

Security

2.4.1

Added

Changed

Deprecated

Removed

Fixed

• Fix dependency on aiohttp (#594)

Security

2.4.0

Added

• Added generating imports and headers to API generator (#467)
• 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)
• Added guide on using index templates (#531)
• Added pool_maxsize for Urllib3HttpConnection (#535)
• Added benchmarks (#537)
• Added guide on making raw JSON REST requests (#542)
• Added support for AWS SigV4 for urllib3 (#547)
• Added remote store client APIs (#552)
• Added nox -rs generate (#554)
• Added a utf-8 header to all .py files (#557)
• Added samples, benchmarks and docs to nox -rs format (#556)
• Added guide on the document lifecycle API(s) (#559)
• Added Windows CI (#569)
• Added client.http JSON REST request API helpers (#544)

Changed

• Generate tasks client from API specs (#508)
• Generate ingest client from API specs (#513)
• Generate dangling_indices client from API specs (#511)
• Generate cluster client from API specs (#530)
• Generate nodes client from API specs (#514)
• Generate cat client from API specs (#529)
• Use API generator for all APIs (#551)
• Merge .pyi type stubs inline (#563)
• Expanded type coverage to benchmarks, samples and tests (#566)
• Defaulted enable_cleanup_closed=True in aiohttp.TCPConnector to prevent TLS connection leaks (#468)
• Expanded nox -rs docs to generate docs (#568)

Deprecated

• 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)

Removed

• Removed leftover support for Python 2.7 (#548)

Fixed

• Fixed automatically built and deployed docs (575)
• Avoid decoding request body unless it needs to be logged (#571)

Security

Dependencies

• Bumps sphinx from <7.1 to <7.3
• Bumps coverage from <7.0.0 to <8.0.0

2.3.2

Added

Changed

Deprecated

Removed

Fixed

Security

Dependencies

• Bumps urllib3 from >=1.21.1, <2 to >=1.26.9 (#518)
• Bumps urllib3 from >=1.26.17 to >=1.26.18 (#576)

2.3.1

Added

Changed

Deprecated

Removed

Fixed

• Fixed race condition in AWSV4SignerAuth & AWSV4SignerAsyncAuth when using refreshable credentials (#470)

Security

Dependencies

• Bumps urllib3 from >= 1.26.9 to >= 1.26.17 #533

2.3.0

Added

• Added async support for helpers that are merged from opensearch-dsl-py (#329)
• Added search.md to guides (#356)
• Added index lifecycle guide (#362)
• Added point in time APIs to the pyi files in sync and async client (#378)
• Added MacOS and Windows CI workflows (#390)
• Added support for the security plugin (#399)
• Supports OpenSearch 2.1.0 - 2.6.0 (#381)
• Added allow_redirects to RequestsHttpConnection#perform_request (#401)
• Enhanced YAML test runner to use OpenSearch rest-api-spec YAML tests (#414)
• Added Search#collapse (#409)
• Added support for the ISM API (#398)
• Added trust_env to AIOHttpConnection (#398)
• Added support for latest OpenSearch versions 2.7.0, 2.8.0 (#445)
• Added samples (#447)
• Improved CI performance of integration with unreleased OpenSearch (#318)
• Added k-NN guide and samples (#449)
• Added the ability to run tests matching a pattern to .ci/run-tests (#454)

Changed

• Moved security from plugins to clients (#442)
• Updated Security Client APIs (#450)

Deprecated

Removed

• Removed support for Python 2.7 (#421)
• Removed support for Python 3.5 (#533)

Fixed

• Fixed flaky CI tests by replacing httpbin with a simple http_server (#395)
• Fixed import cycle when importing async helpers (#311)
• Fixed make docs with sphinx(#433)
• Fixed user guide for async client (#340)
• Include parsed error info in TransportError in async connections (#226)
• Enhanced existing API generator to use OpenSearch OpenAPI spec (#412)
• Fix crash when attempting to authenticate with an async connection (#424)
• Fixed poetry run command issue on Windows/Mac machines (#494)

Security

• Fixed CVE-2022-23491 reported in opensearch-dsl-py (#295)

Dependencies

• Bumps pytest-asyncio to 0.21.0 (#339)
• Bumps sphinx from <1.7 to <7.1
• Bumps pytest-asyncio from <=0.21.0 to <=0.21.1

2.2.0

Added

• Merged opensearch-dsl-py into opensearch-py (#287)
• Added UPGRADING.md and updated it for opensearch-py 2.2.0 release (#293)

Changed

Deprecated

Removed

• Removed 'out/opensearchpy' folder which was produced while generating pyi files for plugins (#288)
• Removed low-level and high-level client terminology from guides (#298)

Fixed

• Fixed CVE-2022-23491 (#295)

Security

2.1.1

Added

Changed

Deprecated

Removed

Fixed

• Fixed SigV4 Signing for Managed Service (#279)
• Fixed SigV4 Signing for Async Requests with QueryStrings (#272)

Security

2.1.0

Added

• Added Support for AOSS (#268)

Changed

Deprecated

Removed

Fixed

Security

2.0.1

Added

• Added point in time support (#191)
• Added pool_maxsize for RequestsHttpConnection (#216)
• Added Github workflow for CHANGELOG verification (#218)
• Added overload decorators to helpers-actions.pyi-bulk (#239)
• Documented Keberos authentication (214)
• Added release workflows (#240)
• Added SigV4 support for async (#254)
• Compatibility with OpenSearch 2.1.0 - 2.4.1 (#257)
• Added explicit parameters for AIOHttpConnection and AsyncTransport (#276)
• Added support for a custom signing service name for AWS SigV4 (#268)

Changed

• Updated getting started in user guide (#233)
• Updated CA certificate handling to check OpenSSL environment variables before defaulting to certifi (#196)
• Updated master to cluster_manager to be inclusive (#242)
• Updated CI tests to make them work locally (#275)
• Fixed bug with validation of timeout (#387)

Deprecated

Removed

• Removed patch versions in integration tests for OpenSearch 1.0.0 - 2.3.0 to reduce Github Action jobs (#262)

Fixed

• Fixed DeprecationWarning emitted from urllib3 1.26.13+ (#246)
• Fixed Wrong return type hint in async_scan (520)

Security