-
Notifications
You must be signed in to change notification settings - Fork 123
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated COMPATIBILITY.md Signed-off-by: Theo Truong <[email protected]>
- Loading branch information
Showing
3 changed files
with
19 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters