Skip to content

Commit 13c80c0

Browse files
committed
Updated COMPATIBILITY.md
Signed-off-by: Theo Truong <[email protected]>
1 parent e45dd59 commit 13c80c0

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

COMPATIBILITY.md

+16-18
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,23 @@
33

44
## Compatibility with OpenSearch
55

6-
The below matrix shows the compatibility of the [`opensearch-ruby`](https://rubygems.org/gems/opensearch-ruby) with versions of [`OpenSearch`](https://opensearch.org/downloads.html#opensearch).
6+
The OpenSearch Ruby client is comprised of three gems:
7+
- [`opensearch-transport`](https://rubygems.org/gems/opensearch-transport) - the transport layer
8+
- [`opensearch-api`](https://rubygems.org/gems/opensearch-api) - the API definitions
9+
- [`opensearch-ruby`](https://rubygems.org/gems/opensearch-ruby) - the client itself that ties the two above together
710

8-
| OpenSearch Version | Client Version |
9-
| --- | --- |
10-
| 1.0.0 | 1.0.0 |
11-
| 1.0.1 | 1.0.0 |
12-
| 1.1.0 | 1.0.0 |
13-
| 1.2.0 | 1.0.0 |
14-
| 1.2.1 | 1.0.0 |
15-
| 1.2.2 | 1.0.0 |
16-
| 1.2.3 | 1.0.0 |
17-
| 1.2.4 | 1.0.0 |
18-
| 1.3.0 | 1.0.0 |
19-
| 1.3.1 | 1.0.0 |
20-
| 1.3.2 | 1.0.0 |
21-
| 1.3.3 | 1.0.0 |
22-
| 2.0.0 | 2.0.2 |
23-
| 2.0.1 | 2.0.2 |
11+
The vast majority of changes to OpenSearch are reflected in the API definitions, and the `opensearch-api` gem is updated to reflect those changes. The transport layer is updated only when there are changes to the underlying HTTP library, or when there are changes to the OpenSearch API that require changes to the transport layer.
12+
13+
Below is the table of OpenSearch versions and the **recommended minimum versions** of `opensearch-api` and the corresponding `opensearch-ruby` and `opensearch-transport`:
14+
15+
| OpenSearch Version | `opensearch-api` Version | `opensearch-ruby` Version | `opensearch-transport` Version |
16+
|--------------------|--------------------------|---------------------------|--------------------------------|
17+
| 1.x | 1.0 | 1.0 | 1.0 |
18+
| 2.1 | 2.1 | 2.1 | 2.0 |
19+
| 2.2 | 2.1 | 2.1 | 2.0 |
20+
| 2.3 | 2.1 | 2.1 | 2.0 |
21+
| 2.4 | 2.2 | 2.1 | 2.0 |
2422

2523
## Upgrading
2624

27-
Major versions of OpenSearch introduce breaking changes that require careful upgrades of the client. While `opensearch-ruby-client` 2.0.2 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.
25+
Major versions of OpenSearch introduce breaking changes that require careful upgrades of the client. While `opensearch-api` 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.

0 commit comments

Comments
 (0)