General

• Tested with Elastic Enterprise Search API version 7.14.0.

App Search

• Adds API Key endpoints: api_key, create_api_key, delete_api_key, list_api_keys, put_api_key - Documentation.

Workplace Search

• Adds synonym set endpoints: create_batch_synonym_sets, delete_synonym_set, list_synonym_sets, put_synonym_set, synonym_set - Documentation.
• Adds current_user endpoint - Documentation
• Adds command_sync_jobs endpoint - Documentation
• Adds delete_documents_by_query endpoint - Documentation.
• Adds put_content_source_icons endpoint - Documentation

• Elastic Transport: Locks dependency version to < 7.14
• Elastic Transport: Adds ENTERPRISE_SERVICE_VERSION constant for compatibility

General

• Tested with Elastic Enterprise Search API version 7.13.0.
• Improved meta header implementation for Elastic Cloud.

Workplace Search

• The client now supports Basic Authentication and Elasticsearch tokens. All Workplace Search APIs support Basic Authentication, Elasticsearch tokens and Workplace Search admin user access tokens as an authentication method. You still need to set up user access tokens generated by the Workplace Search OAuth Service for the Search API and the Analytics Events API.
• New APIs:
  • document: Retrieve a document by ID from a specified content source.
  • delete_all_documents: Delete all documents for a given content source
  • content_source: Retrieves a content source by ID
  • create_content_source: Creates a custom content source
  • delete_content_source: Deletes a content source by ID
  • list_content_sources: Retrieves all content sources
  • put_content_source: Updates a custom content source

• This is a pre-release, full Changelog details will be published with the final release of 7.13.0
• Support for Enterprise Search API v7.13.0

7.12.0 Release notes

General

• Tested with Elastic Enterprise Search API version 7.12.0.
• Adds multi filter example to App Search docs.
• Bumps elasticsearch-transport dependency to version 7.11 and up.
• Updates run-local script to fix rake stack task.

App Search

• Updates source code documentation for current_page and page_size parameters from type String to Integer.
• In multi_search, the body parameter is renamed to body from queries to avoid repetition and potential confusion.

Workplace Search

• Body parameter renamed to document_ids in delete_documents:

client.delete_documents(content_source_id, document_ids: ['e68fbc2688f1', 'c535e226aee3'])

First General Availability Release! 🎉 The stability has been upgrade from beta to GA.

• All App Search, Workplace Search and Enterprise Search API endpoints have been implemented updated to the 7.11 specification, and have been tested and documented.
• Docs were migrated to https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/index.html
• Some endpoints both in App Search and Workplace Search have changed to have named parameters for body when it makes sense.
• Support for per request custom HTTP headers was added. See docs.
• Support for per request http authentication was added when using OAuth. See docs.
• Tested with Ruby 3.
• Sends the X-Elastic-Client-Meta HTTP header which is used by Elastic Cloud and can be disabled with the enable_meta_header parameter.

App Search

• Added support for signed search key in App Search.

Workplace Search

• content_source_key was deprecated in favour of content_source_id.
• Added support for OAuth.
• With OAuth support, search and create_analytics APIs are now also available.

First beta release of the Elastic Enteprise Search Ruby Client. Please check out the README and try it out!
It supports the 7.10.0 API for Elastic Enterprise Search, App Search and Workplace Search.

:octocat: Report any issues here.

📦 Install:

$ gem install elastic-enterprise-search --pre

Or add to your Gemfile:

gem 'elastic-enterprise-search'

📥 Rubygems: https://rubygems.org/gems/elastic-enterprise-search/versions/7.10.0.beta.1

Initial pre-release of the Elastic Enteprise Search Ruby Client.

https://rubygems.org/gems/elastic-enterprise-search/versions/7.10.0.pre