v8.9.0

• Refactored User-Agent code, it is now set up on initializing the client instead of every request.
• Tested versions of Ruby for 8.9.0: Ruby (MRI) 3.0, 3.1 and 3.2, JRuby 9.3 and JRuby 9.4.
• Updated for compatibility with Elastic Enterprise Search 8.9's API.

v8.8.0

• Tested versions of Ruby for 8.8.0: Ruby (MRI) 3.0, 3.1 and 3.2, JRuby 9.3 and JRuby 9.4.
• Updated for compatibility with Elastic Enterprise Search 8.8's API.

v8.7.0

• Tested versions of Ruby for 8.7.0: Ruby (MRI) 2.7, 3.0, 3.1 and 3.2, JRuby 9.3 and JRuby 9.4.
• Updated for compatibility with Elastic Enterprise Search 8.7's API.

App Search

• Fixed source code documentation for Search API. Updated parameter boost to boosts.

8.6.0

• Tested versions of Ruby for 8.6.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3 and JRuby 9.4.
• Updated for compatibility with Elastic Enterprise Search 8.6's API.

8.5.0

Client

Updates dependency on elastic-transport. With the latest release of elastic-transport - v8.1.0 - this gem now supports Faraday v2. When you upgrade your gems, 8.1.0 will be installed. This supports both Faraday v1 and Faraday v2. The main change on dependencies when using Faraday v2 is all adapters, except for the default net_http one, have been moved out of Faraday into separate gems. This means if you're not using the default adapter and you migrate to Faraday v2, you'll need to add the adapter gems to your Gemfile.

These are the gems required for the different adapters with Faraday 2, instead of the libraries on which they were based:

# HTTPCLient
gem 'faraday-httpclient'
# NetHTTPPersistent
gem 'faraday-net_http_persistent'
# Patron
gem 'faraday-patron'
# Typhoeus
gem 'faraday-typhoeus'

Things should work fine if you migrate to Faraday 2 as long as you include the adapter (unless you're using the default one net-http), but worst case scenario, you can always lock the version of Faraday in your project to 1.x:
gem 'faraday', '~> 1'

Troubleshooting

If you see a message like:

:adapter is not registered on Faraday::Adapter (Faraday::Error)

Then you probably need to include the adapter library in your gemfile and require it.

Please submit an issue if you encounter any problems.

App Search

• Adds precision_enabled (Boolean) to put_search_settings. See https://www.elastic.co/guide/en/app-search/current/search-settings.html#search-settings-update[here] for more information.
• search_es_search and search_explain changed the path to api/as/v1 instead of v0 and are now GA with version 8.5 of the stack.

7.17.1

• Updates in Documentation: CHANGELOG, CODE_OF_CONDUCT, CONTRIBUTING, NOTICE, README
• Adds the option to specify an adapter for Faraday when initializing a client. See README
• Fixes typo in meta data for CLIENT_NAME.

8.4.0

• Tested versions of Ruby for 8.4.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3.
• Updated for compatibility with Elastic Enterprise Search 8.4's API.
• Fixed client name String in meta header

Changes to Elasticsearch Search in App Search

CAUTION
The Elasticsearch search API for App Search is a beta feature. Beta features are subject to change and are not covered by the support SLA of generally available (GA) features. Elastic plans to promote this feature to GA in a future release.

The Elasticsearch Search API search_es_search has been updated to be more consistent with the Elasticsearch _search API.

In the previous version, a request object was required in the request:

# DEPRECATED - This worked for 8.3 but has been updated in 8.4:
es_request = { body: { query: { bool: { must: { term: { title: 'test' } } } } } }
client.search_es_search(engine_name, body: { request: es_request })

This has been simplified to:

es_request = { query: { bool: { must: { term: { title: 'test' } } } } }
client.search_es_search(engine_name, body: es_request)

8.3.0

• Tested versions of Ruby for 8.3.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3.
• General small improvements in documentation.
• Updated for compatibility with Elastic Enterprise Search 8.3's API.

Enterprise Search

New API: search_engines - Retrieve information about search engines

8.2.1

• Adds tracer parameters to enable tracing in elastic-transport. See logging for more information.
• Updates Workplace Search OAuth implementation. See OAuth Authentication for changes in the OAuth process.

8.1.1

• Adds tracer parameters to enable tracing in elastic-transport. See logging for more information.
• Updates Workplace Search OAuth implementation. See OAuth Authentication for changes in the OAuth process.