Skip to content

Latest commit

 

History

History
281 lines (264 loc) · 24.2 KB

CHANGELOG.md

File metadata and controls

281 lines (264 loc) · 24.2 KB
Raw

CHANGELOG

Inspired from Keep a Changelog

Unreleased

Added

  • Added option to pass custom headers to 'AWSV4SignerAsyncAuth' (863)
  • Added sync and async sample that uses search_after parameter (859)

Updated APIs

Changed

  • Small refactor of AWS Signer classes for both sync and async clients (866)
  • Small refactor to fix overwriting the module files when generating apis (874)
  • Fixed a "type ignore" lint error

Deprecated

Removed

Fixed

Security

2.8.0

Added

  • Added AsyncSearch#collapse (827)
  • Added pool_maxsize to AsyncOpenSearch (845)
  • Added ssl_assert_hostname to AsyncOpenSearch (843)

Updated APIs

Fixed

  • Fix Transport.perform_request's arguments timeout and ignore variable usage (810)
  • Fix Index.save not passing through aliases to the underlying index (823)
  • Fix AuthorizationException with AWS OpenSearch when the doc ID contains : (848)

Dependencies

  • Bump pytest-asyncio from <=0.23.8 to <=0.24.0 (#812)
  • Bump sphinx from <8.1 to <8.2 (#832)

2.7.1

Fixed

  • Fix indices.put_alias parameter order regression (#804)

2.7.0

Added

  • Added support for the multi_terms bucket aggregation (#797)

Changed

  • Removed deprecated numpy.float_ and update NumPy/Pandas imports (#762)
  • Removed workaround for aiohttp#1769 (#794)

Removed

  • Removed redundant dependency on six (#781)
  • Removed redundant dependency on mock and upgrade Python syntax (#785)

Fixed

  • Fixed Search helper to ensure proper retention of the _collapse attribute in chained operations. (#771)
  • Fixed the use of minimum_should_match with Bool to allow the use of string-based value (percent string, combination). (#780)
  • Fixed incorrect retry_on_conflict type (#795)

Updated APIs

Dependencies

  • Bump pytest-asyncio from <=0.23.7 to <=0.23.8 (#787)
  • Bump sphinx from <7.4 to <8.1 (#788, #791)
  • Bump urllib3 from >=1.26.18 to >=1.26.19 (#793)
  • Bump requests from >=2.4.0 to >=2.32.0 (#793)
  • Bump certifi from >=2022.12.07 to >=2024.07.04 (#793)

2.6.0

Added

  • Added support for urllib3 2+ in Python 3.10+ (#719)
  • Added support for Python 3.12 (#717)
  • Added service time metrics (#716)
  • Added search_pipeline APIs and notifications plugin APIs (#724)
  • Added Transforms APIs (#749)
  • Added Index rollups APIs (#742)

Removed

  • Removed support for Python 3.6, 3.7 (#717)

Fixed

  • Updated code generator to use native OpenAPI specification (#721)

Updated APIs

Dependencies

  • Bumps aiohttp from >=3,<4 to >=3.9.2,<4 (#717)
  • Bumps black to >=24.3.0 (#717)
  • Bumps pytest-asyncio from <=0.23.5 to <=0.23.7
  • Bumps sphinx from <7.3 to <7.4
  • Bumps aiohttp from >=3.9.2,<4 to >=3.9.4,<4 (#751)

2.5.0

Added

  • Added pylint assignment-from-no-return and unused-variable (#658)
  • Added pylint unnecessary-dunder-calls (#655)
  • Changed to use .pylintrc files in root and any directory with override requirements (#654)
  • Added pylint unspecified-encoding and missing-function-docstring and ignored opensearchpy for lints (#643)
  • Added pylint line-too-long and invalid-name (#590)
  • Added pylint pointless-statement (#611)
  • Added a log collection guide (#579)
  • Added GHA release (#614)
  • Incorporated API generation into CI workflow and fixed 'generate' nox session (#660)
  • Added an automated api update bot for opensearch-py (#664)
  • Enhance generator to generate plugins (#700)
  • Enhance generator to update changelog only if generated code differs from existing (#684)
  • Added guide for configuring ssl_assert_hostname (#694)

Changed

  • Pass in initial admin password in setup and remove default admin password (#631)
  • Updated the get_policy API in the index_management plugin to allow the policy_id argument as optional (#633)
  • Updated the point_in_time.md guide with examples demonstrating the usage of the new APIs as alternatives to the deprecated ones. (#661)

Removed

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

Fixed

  • Fix KeyError when scroll return no hits (#616)
  • Fix reuse of OpenSearch using Urllib3HttpConnection and AsyncOpenSearch after calling close (#639)

Updated APIs

Dependencies

  • Bumps pytest-asyncio from <=0.21.1 to <=0.23.5
  • Bumps urllib3 from >=1.26.18 to >=1.26.18, <2 (#632)

2.4.2

Fixed

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

2.4.1

Fixed

  • Fix dependency on aiohttp (#594)

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)

Dependencies

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

2.3.2

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

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

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)
  • Added a guide for taking snapshots (#486)

Changed

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

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)

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)

2.1.1

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

2.1.0

Added

  • Added Support for AOSS (#268)

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)

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)
  • Fixed link checker failing due to relative link (#760)

Security