Release Notes

edit

7.x

edit

7.14 Release notes

edit

7.14.1 Release notes

edit

Dependency fix

edit

Updates dependency on elasticsearch-transport to be more open. At least 7.11 is required, but this way it can be used with different versions of the elasticsearch gem (bigger than or equal to 7.11) in the same project, without a conflict in elasticsearch-transport. When instantiating transport, we now check if version is < 7.14 so we use the right class.

7.14.0 Release notes

edit

General

edit
  • Tested with Elastic Enterprise Search API version 7.14.0.

App Search

edit
  • Adds API Key endpoints: api_key, create_api_key, delete_api_key, list_api_keys, put_api_key

Workplace Search

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

7.13.0 Release notes

edit

General

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

Workplace Search

edit
  • 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

7.12 Release notes

edit

7.12.1 Release notes

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

7.12.0 Release notes

edit

General

edit

App Search

edit
  • 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.

7.11.0 Release notes

edit

First General Availability Release

General

edit
  • 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 moved from the README file to asciidocs.
  • 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

edit
  • Added support for signed search key in App Search.

Workplace Search

edit
  • 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.

7.10.0.beta.1 Release notes

edit

First beta release. It supports the 7.10.0 API for Elastic Enterprise Search, App Search and Workplace Search.