From 86f7d71f5647c8d4c8e4cd6cde939e0ef42ea116 Mon Sep 17 00:00:00 2001 From: Theo Nam Truong Date: Tue, 3 Oct 2023 16:55:30 -0600 Subject: [PATCH] Bumped Version to 2.4.0 (#623) Updated COMPATIBILITY.md Signed-off-by: Theo Truong --- CHANGELOG.md | 16 ++++++++++------ COMPATIBILITY.md | 30 ++++++++---------------------- package.json | 2 +- 3 files changed, 19 insertions(+), 29 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6972949ed..2c4230b7b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,16 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ## [Unreleased] ### Added -- Added Security API +### Dependencies +### Changed +### Deprecated +### Removed +### Fixed +### Security + +## [2.4.0] +### Added +- Added Security API ([#606](https://github.com/opensearch-project/opensearch-js/pull/606)) - Documentation for edge-case in Sigv4Signer ([#622](https://github.com/opensearch-project/opensearch-js/pull/622)) ### Dependencies - Bumps `rimraf` from 5.0.0 to 5.0.5 @@ -178,8 +187,3 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ### Fixed - Fix mutability of connection headers ([#291](https://github.com/opensearch-project/opensearch-js/issues/291)) - -[2.1.0]: https://github.com/opensearch-project/opensearch-js/releases/tag/2.1.0 -[2.2.0]: https://github.com/opensearch-project/opensearch-js/releases/tag/2.2.0 -[2.2.1]: https://github.com/opensearch-project/opensearch-js/releases/tag/2.2.1 -[Unreleased]: https://github.com/opensearch-project/opensearch-js/compare/2.2.1...HEAD diff --git a/COMPATIBILITY.md b/COMPATIBILITY.md index 2308e52c0..c65ac20fe 100644 --- a/COMPATIBILITY.md +++ b/COMPATIBILITY.md @@ -1,27 +1,13 @@ -- [Compatibility with OpenSearch](#compatibility-with-opensearch) -- [Upgrading](#upgrading) +# Compatibility with OpenSearch -## Compatibility with OpenSearch +The below matrix shows the compatibility of the [`opensearch-js`](https://www.npmjs.com/package/@opensearch-project/opensearch) with versions of [`OpenSearch`](https://opensearch.org/downloads.html#opensearch). In the vast majority of cases, a minor version upgrade of the OpenSearch Server does not affect how your application's existing features interact with the cluster via the JavaScript client. However, such an upgrade can introduce new endpoints that your current version of the client does not support. In this case, you must upgrade the client to the version shown in the table below (or higher) to use the new endpoints. -The below matrix shows the compatibility of the [`opensearch-js`](https://www.npmjs.com/package/@opensearch-project/opensearch) with versions of [`OpenSearch`](https://opensearch.org/downloads.html#opensearch). +If your Server Version is higher than those listed in the table below, you should use the newest client. If the newest client still does not support the endpoint you need, please open an issue and let us know. -| OpenSearch Version | Client Version | -| ------------------ | -------------- | -| 1.0.0 | 1.0.0 | -| 1.0.1 | 1.0.0 | -| 1.1.0 | 1.1.0 | -| 1.2.0 | 1.1.0 | -| 1.2.1 | 1.1.0 | -| 1.2.2 | 1.1.0 | -| 1.2.3 | 1.1.0 | -| 1.2.4 | 1.1.0 | -| 1.3.0 | 1.1.0 | -| 1.3.1 | 1.1.0 | -| 1.3.2 | 1.1.0 | -| 1.3.3 | 1.1.0 | -| 2.0.0 | 2.0.0 | -| 2.0.1 | 2.0.0 | +| Server Version | Client Version | +|----------------|----------------| +| 1.x | 1.x | +| 2.x | 2.x | ## Upgrading - -Major versions of OpenSearch introduce breaking changes that require careful upgrades of the client. While `opensearch-js` 2.0.0 works against the latest OpenSearch 1.x, certain deprecated features removed in OpenSearch 2.0 have also been removed from the client. Please refer to the [OpenSearch documentation](https://opensearch.org/docs/latest/clients/index/) for more information. +Major versions of OpenSearch introduce breaking changes that require careful upgrades of the client. While `opensearch-js` 2.x works against the latest OpenSearch 1.x, certain deprecated features removed in OpenSearch 2.0 have also been removed from the client. Please refer to the [OpenSearch documentation](https://opensearch.org/docs/latest/clients/index/) for more information. diff --git a/package.json b/package.json index df1b3e6ed..b928f6a34 100644 --- a/package.json +++ b/package.json @@ -23,7 +23,7 @@ } }, "homepage": "https://www.opensearch.org/", - "version": "2.3.0", + "version": "2.4.0", "versionCanary": "7.10.0-canary.6", "keywords": [ "opensearch",