From b972d01b6387480717533b0e75be881a49766ec4 Mon Sep 17 00:00:00 2001 From: Theo Truong Date: Mon, 17 Apr 2023 11:33:22 -0600 Subject: [PATCH] Updated COMPATIBILITY.md Signed-off-by: Theo Truong --- COMPATIBILITY.md | 34 ++++++++++++++++------------------ opensearch-aws-sigv4/Gemfile | 3 +++ 2 files changed, 19 insertions(+), 18 deletions(-) diff --git a/COMPATIBILITY.md b/COMPATIBILITY.md index b883a857c..f445e43be 100644 --- a/COMPATIBILITY.md +++ b/COMPATIBILITY.md @@ -3,25 +3,23 @@ ## Compatibility with OpenSearch -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). +The OpenSearch Ruby client is comprised of three gems: +- [`opensearch-transport`](https://rubygems.org/gems/opensearch-transport) - the transport layer +- [`opensearch-api`](https://rubygems.org/gems/opensearch-api) - the API definitions +- [`opensearch-ruby`](https://rubygems.org/gems/opensearch-ruby) - the client itself that ties the two above together -| OpenSearch Version | Client Version | -| --- | --- | -| 1.0.0 | 1.0.0 | -| 1.0.1 | 1.0.0 | -| 1.1.0 | 1.0.0 | -| 1.2.0 | 1.0.0 | -| 1.2.1 | 1.0.0 | -| 1.2.2 | 1.0.0 | -| 1.2.3 | 1.0.0 | -| 1.2.4 | 1.0.0 | -| 1.3.0 | 1.0.0 | -| 1.3.1 | 1.0.0 | -| 1.3.2 | 1.0.0 | -| 1.3.3 | 1.0.0 | -| 2.0.0 | 2.0.2 | -| 2.0.1 | 2.0.2 | +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. + +Below is the table of OpenSearch versions and the **recommended minimum versions** of `opensearch-api`: + +| OpenSearch Version | `opensearch-api` Version | +|--------------------|--------------------------| +| 1.x | 1.0.0 | +| 2.1 | 2.1.0 | +| 2.2 | 2.1.0 | +| 2.3 | 2.1.0 | +| 2.4 | 2.2.0 | ## Upgrading -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. +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. diff --git a/opensearch-aws-sigv4/Gemfile b/opensearch-aws-sigv4/Gemfile index 41407adee..007b0843d 100644 --- a/opensearch-aws-sigv4/Gemfile +++ b/opensearch-aws-sigv4/Gemfile @@ -12,6 +12,9 @@ source 'https://rubygems.org' # Specify your gem's dependencies in opensearch-aws-sigv4.gemspec gemspec +gem 'aws-sdk', '~> 3' +gem 'nokogiri', '~> 1.10.0' + if File.exist? File.expand_path('../opensearch-api/opensearch-api.gemspec', __dir__) gem 'opensearch-api', path: File.expand_path('../opensearch-api', __dir__), require: false end