3.0.0

In Version 3 of the OpenSearch Ruby client, we have added the api and transport modules as the core components of the gem, instead of treating them as separate gems that are required by the opensearch-ruby gem. This removes the confusions around compatibility between the ruby client, its legacy dependencies, and the OpenSearch cluster.

opensearch-dsl has also been moved into opensearch-ruby 3.0. If your application uses opensearch-dsl, you should now remove this gem from your Gemfile or gemspec.

We don't expect the upgrade to OpenSearch Ruby 3 to be a breaking change for the vast majority of use cases, and you do not have to make any changes to your application before the upgrade. On your development environment, you might want to perform a bundle clean to remove opensearch-api, opensearch-transport, and opensearch-dsl gems after the upgrade.

What's Changed

• Merge gems by @nhtruong in #175
• API Generator by @nhtruong in #177
• [Generated Code] Security API by @nhtruong in #179
• [Generated Code] Added remote_store.restore action by @nhtruong in #176
• Added RuboCop. by @dblock in #165
• API Guides by @nhtruong in #162
• Fixed Workflow Issues by @nhtruong in #178

Full Changelog: opensearch-api/2.2...3.0.0

opensearch-api/2.2.0

What's Changed

• Added PIT actions by @nhtruong in #155
• Add 2PR approval to release workflow by @gaiksaya in #152
• Implemented Cache for Unreleased OpenSearch images by @nhtruong in #154

Full Changelog: opensearch-aws-sigv4/1.2.0...opensearch-api/2.2.0

opensearch-aws-sigv4/1.2.0

What's Changed

• Added Sigv4 Debug Logging by @nhtruong in #150

opensearch-aws-sigv4/1.1.0

What's Changed

• Sign validation request when using aws-sigv4 (#130) by @robinroestenburg in #134
• Added Support for Amazon OpenSearch Serverless by @nhtruong in #135

New Contributors

• @robinroestenburg made their first contribution in #134

Full Changelog: opensearch-dsl/0.2.1...opensearch-aws-sigv4/1.1.0

opensearch-transport/2.1.0

What's Changed

• Faraday 2 support for opensearch-transport 2 by @BrianHawley in #76
• Ruby 2.6 works with faraday-typhoeus now by @BrianHawley in #88

opensearch-dsl/0.2.1

What's Changed

• Fixed Mocha Dependency by @nhtruong in #108

opensearch-ruby/2.1.0

• Use safe_load instead of load for yaml by @VachaShah in #77
• Update comments around deprecated and inclusive naming by @harshavamsi in #112

opensearch-aws-sigv4/1.0.0

This is the first release of opensearch-aws-sigv4 gem!

This gem library provides an AWS Sigv4 client for OpenSearch.

Compatibility

The OpenSearch Aws Sigv4 Client is compatible with Ruby 2.5 and higher.

The client's API is compatible with OpenSearch's API versions from 1.0.0 till current.

See COMPATIBILITY for more details.

Installation

Install the package from Rubygems:

gem install opensearch-aws-sigv4

To use an unreleased version, either add it to your Gemfile for Bundler:

gem 'opensearch-aws-sigv4', git: 'git://github.com/opensearch-project/opensearch-ruby.git'

or install it from a source code checkout:

git clone https://github.com/opensearch-project/opensearch-ruby
cd opensearch-ruby/opensearch-aws-sigv4
bundle install
rake install

Usage

This library is an AWS Sigv4 wrapper for opensearch-ruby,
which is a Ruby client for OpenSearch. The OpenSearch::Aws::Sigv4Client is, therefore, has all features of OpenSearch::Client.
And since opensearch-ruby is a dependency of opensearch-aws-sigv4, you only need to install opensearch-aws-sigv4.

require 'opensearch-aws-sigv4'
require 'aws-sigv4'

signer = Aws::Sigv4::Signer.new(service: 'es',
                                region: 'us-west-2',
                                access_key_id: 'key_id',
                                secret_access_key: 'secret')

client = OpenSearch::Aws::Sigv4Client.new({ log: true }, signer)

client.cluster.health

client.transport.reload_connections!

client.search q: 'test'

Please refer to opensearch-ruby documentation for further details.

opensearch-api/2.1.0

• Update comments around deprecated and inclusive naming by @harshavamsi in #112
• Remove deprecated escape_utils. by @dblock in #74
• Adding new OpenSearch versions and updating compatibility matrix by @VachaShah in #73

Version 2.0.3

Version 2.0.2 Release Notes

Compatible with OpenSearch 2.x

Ruby Gems

https://rubygems.org/gems/opensearch-ruby/versions/2.0.3
https://rubygems.org/gems/opensearch-transport/versions/2.0.1

Changes

• Faraday 2 support for opensearch-transport 2 (#85)
• Ruby 2.6 works with faraday-typhoeus now (#89)
• Bumping version to 2.0.1 for opensearch-transport (#94)

Full Changelog: v2.0.2...v2.0.3