elastic-enterprise-search 7.17.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b57d38a9d4bae9ccd2217e1bd94a06b886a394aafef47a15ba645694404f3183
-  data.tar.gz: 3f122a3a3400a56afa448de6d3047df37e897867a2a23be1f24026d76fb31e00
+  metadata.gz: bdfa7f9a297b7be12956c4afb18c566ef6362be6f80b7ddcdf210a63de35792b
+  data.tar.gz: c0ea8e919e929a7a9a03dd183198d7a29f49b95a9fc1e044fb6d1c4becf87adf
 SHA512:
-  metadata.gz: 941c3d7645c1126a267662abaf62993581224ef333ad1c6552b52dbeb24508837362afc6f0c6d030e3043567eaebe2b5caa2972571d2610461f15d7f1cf1c88e
-  data.tar.gz: e85bab13059c21cdade084f4eb6e676be6d091db4b5d8e44326bfa8256b19e76af630ee41d28ecc5ec0a0c52febec826d8fc628d1205d598703b5a2167102363
+  metadata.gz: 9bf7a70b4070b475c5929dee3dce93841db5150bd3502b1b22595ed037cc7f9fbb60e4ade158009af80059ee84f727c192663efd4e9913697bb5860110a327f5
+  data.tar.gz: 11ce05ae809478b90e8980b43b0c28fdfa33d79bb3d398fcf832d1bdb25c7495600cde089bb9d448d3a39599e17484c59bce1704f8f4f0fc5fc362eb2215ce37

data/.ci/jobs/elastic+enterprise-search-ruby+7.15.yml

@@ -0,0 +1,12 @@
+---
+- job:
+    name: elastic+enterprise-search-ruby+7.15
+    display-name: 'elastic / enterprise-search-ruby # 7.15'
+    description: Testing the enterprise-search-ruby 7.15 branch.
+    junit_results: "*-junit.xml"
+    parameters:
+    - string:
+        name: branch_specifier
+        default: refs/heads/7.15
+        description: the Git branch specifier to build (<branchName>, <tagName>,
+          <commitId>, etc.)

data/.ci/jobs/elastic+enterprise-search-ruby+7.16.yml

@@ -0,0 +1,12 @@
+---
+- job:
+    name: elastic+enterprise-search-ruby+7.16
+    display-name: 'elastic / enterprise-search-ruby # 7.16'
+    description: Testing the enterprise-search-ruby 7.16 branch.
+    junit_results: "*-junit.xml"
+    parameters:
+    - string:
+        name: branch_specifier
+        default: refs/heads/7.16
+        description: the Git branch specifier to build (<branchName>, <tagName>,
+          <commitId>, etc.)

data/.ci/test-matrix.yml

@@ -3,10 +3,9 @@ RUBY_VERSION:
   - 3.1
   - 3.0
   - 2.7
-  - 2.6
 
 STACK_VERSION:
-  - 7.17-SNAPSHOT
+  - 8.1-SNAPSHOT
 
 SERVICE:
   - appsearch

data/.github/workflows/testing.yml

@@ -1,4 +1,4 @@
-name: 7.x
+name: main
 on: [push, pull_request]
 
 jobs:
@@ -7,8 +7,7 @@ jobs:
       ENDPOINT: http://localhost:8080
     strategy:
       matrix:
-        ruby: [ '2.6', '2.7', '3.0', '3.1' ]
-
+        ruby: [ '2.7', '3.0', '3.1' ]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
@@ -26,7 +25,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ jruby-9.2 ]
+        ruby: [ jruby-9.3 ]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.6
 Layout/EndAlignment:
   AutoCorrect: true
 Style/StringLiterals:

data/CHANGELOG

@@ -0,0 +1 @@
+See https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/release_notes.html

data/CODE_OF_CONDUCT

@@ -0,0 +1 @@
+See: https://www.elastic.co/community/codeofconduct

data/CONTRIBUTING.md

@@ -1,5 +1,42 @@
 # Contributing to enterprise-search-ruby
 
+## Run Stack locally
+
+A rake task is included to run the Elastic Enterprise Search stack locally via Docker:
+
+```
+$ rake stack[7.10.0]
+```
+
+This will run Elastic Enterprise Search in http://localhost:3002
+- Username: `enterprise_search`
+- Password: `changeme`
+
+The version of the Elastic Enterprise Search Stack to use should be the same as tags of `https://www.docker.elastic.co/r/enterprise-search`. You can also use SNAPSHOT builds such as `8.0.0-SNAPSHOT`, `7.11-SNAPSHOT`, etc.
+
+## Running Tests
+
+Unit tests for the clients:
+
+```
+$ rake spec:client
+```
+
+Integration tests: you need to have an instance of Enterprise Search running either locally or remotely, and specify the host and credentials in environment variables (see below for a complete dockerized setup). If you're using the included rake task `rake stack[:version]`, you can run the integration tests with the following command:
+
+```
+$ ELASTIC_ENTERPRISE_HOST='http://localhost:3002' \
+  ELASTIC_ENTERPRISE_USER='elastic' \
+  ELASTIC_ENTERPRISE_PASSWORD='changeme' \
+  rake spec:integration
+```
+
+Run integration tests completely within containers, the way we run them on our CI:
+```
+RUNSCRIPTS=enterprise-search STACK_VERSION=7.10.0 ./.ci/run-tests
+```
+
+
 ## Contributing Code Changes
 
 1. Please make sure you have signed the [Contributor License

data/NOTICE

@@ -0,0 +1,2 @@
+Elastic Enterprise Search Ruby Client
+Copyright 2021 Elasticsearch B.V.

data/README.md

@@ -6,48 +6,44 @@
 
 Official Ruby API client for [Elastic Enterprise Search](https://www.elastic.co/enterprise-search). Use this gem to integrate App Search and Workplace Search into your Ruby code.
 
-## Documentation
-
-[See the documentation](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/index.html) for compatibility info, configuring, and an API reference.
-
-## Development
-
-### Run Stack locally
+## Installation
 
-A rake task is included to run the Elastic Enterprise Search stack locally via Docker:
+Install the `elastic-enterprise-search` gem from [Rubygems](https://rubygems.org/gems/elastic-enterprise-search):
 
 ```
-$ rake stack[7.10.0]
+$ gem install elastic-enterprise-search
 ```
 
-This will run Elastic Enterprise Search in http://localhost:3002
-- Username: `enterprise_search`
-- Password: `changeme`
+Or add it to your project's Gemfile:
 
-The version of the Elastic Enterprise Search Stack to use should be the same as tags of `https://www.docker.elastic.co/r/enterprise-search`. You can also use SNAPSHOT builds such as `8.0.0-SNAPSHOT`, `7.11-SNAPSHOT`, etc.
+```ruby
+gem 'elastic-enterprise-search', 'VERSION'
+```
 
-### Running Tests
+The Enterprise Search client is implemented with [`elastic-transport`](https://github.com/elastic/elastic-transport-ruby/) as the HTTP layer, which uses [Faraday](https://rubygems.org/gems/faraday). Faraday supports several [adapters](https://lostisland.github.io/faraday/adapters/) and will use `Net::HTTP` by default. For optimal performance with the Enterprise Search API, we suggest using an HTTP library which supports persistent ("keep-alive") connections. For the standard Ruby implementation, this could be https://github.com/drbrain/net-http-persistent[Net::HTTP::Persistent], [patron](https://github.com/toland/patron) or [Typhoeus](https://github.com/typhoeus/typhoeus). For JRuby, [Manticore](https://github.com/cheald/manticore) is a great option as well. Require the library for the adapter in your code and then pass in the `:adapter` parameter to the client when you initialize it:
 
-Unit tests for the clients:
+```ruby
+require 'elastic-enterprise-search'
+require 'faraday/net_http_persistent'
 
+client = Elastic::EnterpriseSearch::Client.new(adapter: :net_http_persistent)
 ```
-$ rake spec:client
-```
+If an adapter is not specified, the client will try to auto-detect available libraries and use the best available HTTP client.
 
-Integration tests: you need to have an instance of Enterprise Search running either locally or remotely, and specify the host and credentials in environment variables (see below for a complete dockerized setup). If you're using the included rake task `rake stack[:version]`, you can run the integration tests with the following command:
+## Documentation
 
-```
-$ ELASTIC_ENTERPRISE_HOST='http://localhost:3002' \
-  ELASTIC_ENTERPRISE_USER='elastic' \
-  ELASTIC_ENTERPRISE_PASSWORD='changeme' \
-  rake spec:integration
-```
+[See the documentation](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/index.html) for usage, code examples, configuring the client, and an API reference.
 
-Run integration tests completely within containers, the way we run them on our CI:
-```
-RUNSCRIPTS=enterprise-search STACK_VERSION=7.10.0 ./.ci/run-tests
-```
+See code examples of usage for the [Enteprise Search](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/enterprise-search-api.html), [App Search](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/app-search-api.html) and [Workplace Search](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/workplace-search-api.html) APIs.
+
+## Compatibility
+
+We follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/).
+
+## Development
+
+See [CONTRIBUTING](https://github.com/elastic/enterprise-search-ruby/blob/main/CONTRIBUTING.md).
 
 ## License
 
-Apache-2.0
+This software is licensed under the [Apache 2 license](./LICENSE). See [NOTICE](./NOTICE).

data/docs/guide/app-search-api.asciidoc

@@ -8,7 +8,7 @@ This document includes examples for different API requests. Please refer to the
 [source,rb]
 ----------------------------
 # Create an engine
-client.create_engine(name: 'videogames')
+client.create_engine(body: { name: 'videogames' })
 
 # List all engines
 client.list_engines
@@ -30,7 +30,7 @@ body = {
   type: 'meta',
   source_engines: [ 'books', 'videogames' ]
 }
-client.create_engine(name: engine_name, body: body)
+client.create_engine(body: body)
 
 # Add a source engine to a meta engine:
 client.add_meta_engine_source(meta_engine_name, source_engines: ['engine1', 'engine2'])
@@ -123,11 +123,13 @@ client.delete_synonym_set(engine_name, synonym_set_id: id)
 ----------------------------
 # Create a curation
 client.create_curation(
-         engine_name,
-         queries: ['query1'],
-         promoted: ['doc-id1'],
-         hidden: ['doc-id2']
-       )
+  engine_name,
+  body: {
+    queries: ['query1'],
+    promoted: ['doc-id1'],
+    hidden: ['doc-id2']
+  }
+)
 
 # Retrieve a curation by id:
 client.curation(engine_name, curation_id: 'cur-id')
@@ -135,10 +137,14 @@ client.curation(engine_name, curation_id: 'cur-id')
 # Update an existing curation:
 client.put_curation(
   engine_name,
-  curation_id: 'cur-id',
-  queries: ['query1'],
-  promoted: ['doc-id2'],
-  hidden: ['doc-id1']
+  {
+    curation_id: 'cur-id',
+    body: {
+      queries: ['query1'],
+      promoted: ['doc-id2'],
+      hidden: ['doc-id1']
+    }
+  }
 )
 
 # List existing curations:
@@ -178,13 +184,6 @@ client.delete_api_key(api_key_name: name)
 
 === Web Crawler
 
-[CAUTION]
-====
-The Elastic Enterprise Search web crawler API is a *beta* feature.
-Beta features are subject to change and are not covered by the support SLA of general release (GA) features.
-Elastic plans to promote this feature to GA in a future release.
-====
-
 See https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html[Web Crawler API reference] for more information.
 
 [source,rb]
@@ -196,6 +195,9 @@ client.create_crawler_domain(engine_name, body: body)
 # Get crawler domain information
 client.crawler_domain(engine_name, domain_id: domain_id)
 
+# List crawler domains
+client.list_crawler_domains(engine_name)
+
 # Update a crawler domain
 body = { name: 'https://www.wikipedia.org' }
 client.put_crawler_domain(engine_name, domain_id: domain_id, domain: body)
@@ -302,6 +304,38 @@ client.crawler_process_crawl_denied_urls(engine_name, process_crawl_id: id)
 client.delete_crawler_active_crawl_request(engine_name)
 ----------------------------
 
+=== Adaptive Relevance Suggestions
+
+[source,rb]
+----------------------------
+# Update an adaptive relevance suggestion
+body = [{ query: 'forest', type: 'curation', status: 'applied' }]
+client.put_adaptive_relevance_suggestions(engine_name, body: body)
+
+# Retrieve an adaptive relevance suggestion
+client.adaptive_relevance_suggestions(engine_name, search_suggestion_query: 'test')
+
+# List adaptive relevance suggestions
+client.list_adaptive_relevance_suggestions(engine_name)
+----------------------------
+
+=== Adaptive Relevance Settings
+
+[source,rb]
+----------------------------
+# Show the settings for an engine
+client.adaptive_relevance_settings(engine_name)
+
+# Update relevance settings
+ body = {
+        curation: { enabled: true }
+      }
+client.put_adaptive_relevance_settings(engine_name, body: body)
+
+# Refresh adaptive relevance update process
+client.refresh_adaptive_relevance_update_process(engine_name, adaptive_relevance_suggestion_type: 'curation')
+----------------------------
+
 === Other API Endpoints
 
 [source,rb]

data/docs/guide/overview.asciidoc

@@ -14,11 +14,19 @@ For **Elastic Enterprise Search 7.0** and later, use the major version 7 (`7.x.y
 
 [discrete]
 === HTTP Library
-This library uses https://github.com/elastic/elasticsearch-ruby/tree/main/elasticsearch-transport[elasticsearch-transport], the low-level Ruby client for connecting to an Elasticsearch cluster - also used in the official https://github.com/elastic/elasticsearch-ruby[Elasticsearch Ruby Client].
+This library uses https://github.com/elastic/elastic-transport-ruby[elastic-transport], the low-level Ruby client for connecting to an Elastic clusters - also used in the official https://github.com/elastic/elasticsearch-ruby[Elasticsearch Ruby Client]. It uses https://rubygems.org/gems/faraday[Faraday], which supports several https://lostisland.github.io/faraday/adapters/[adapters] and will use `Net::HTTP` by default. For optimal performance with the Enterprise Search API, we suggest using an HTTP library which supports persistent ("keep-alive") connections. For the standard Ruby implementation, this could be https://github.com/drbrain/net-http-persistent[Net::HTTP::Persistent], https://github.com/toland/patron[patron] or https://github.com/typhoeus/typhoeus[Typhoeus]. For JRuby, https://github.com/cheald/manticore[Manticore] is a great option as well. Require the library for the adapter in your code and then pass in the `:adapter` parameter to the client when you initialize it:
 
-All requests, if successful, will return an `Elasticsearch::Transport::Transport::Response` instance. You can access the response `body`, `headers` and `status`.
+[source,ruby]
+---------------------------------------------------
+require 'elastic-enterprise-search'
+require 'faraday/net_http_persistent'
 
-`elasticsearch-transport` defines a https://github.com/elasticsearch/elasticsearch-ruby/blob/main/elasticsearch-transport/lib/elasticsearch/transport/transport/errors.rb[number of exception classes] for various client and server errors, as well as unsuccessful HTTP responses, making it possible to rescue specific exceptions with desired granularity. More details https://github.com/elastic/elasticsearch-ruby/tree/main/elasticsearch-transport#exception-handling[here]. You can find the full documentation for `elasticsearch-transport` at https://rubydoc.info/gems/elasticsearch-transport[RubyDoc].
+client = Elastic::EnterpriseSearch::Client.new(adapter: :net_http_persistent)
+---------------------------------------------------
+
+All requests, if successful, will return an `Elastic::Transport::Transport::Response` instance. You can access the response `body`, `headers` and `status`.
+
+`elastic-transport` defines a https://github.com/elastic/elastic-transport-ruby/blob/main/lib/elastic/transport/transport/errors.rb[number of exception classes] for various client and server errors, as well as unsuccessful HTTP responses, making it possible to rescue specific exceptions with desired granularity. More details https://github.com/elastic/elastic-transport-ruby#exception-handling[here]. You can find the full documentation for `elastic-transport` at https://rubydoc.info/gems/elastic-transport[RubyDoc].
 
 The clients pass different options to transport, you can check them out https://rubydoc.info/github/elastic/enterprise-search-ruby/Elastic/EnterpriseSearch/Client[on RubyDocs].
 

data/docs/guide/release_notes/712.asciidoc

@@ -26,3 +26,13 @@
 
 - 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.
+
+[discrete]
+==== Workplace Search
+
+- Body parameter renamed to `document_ids` in `delete_documents`:
+
+[source,rb]
+----------------------------
+client.delete_documents(content_source_id, document_ids: ['e68fbc2688f1', 'c535e226aee3'])
+----------------------------

data/docs/guide/release_notes/80.asciidoc

@@ -0,0 +1,117 @@
+[[release_notes_80]]
+=== 8.0.0 Release notes
+
+[discrete]
+==== General
+
+First release in the `8.x` branch of the client.
+
+- Tested with Elastic Enterprise Search API version 8.0-SNAPSHOT.
+- Tested with Ruby 2.7, 3.0, 3.1, JRuby 9.3. Older versions of Ruby have reached end of life and been removed from the testing matrices. Minimum required Ruby version is Ruby 2.6 to keep compatibility with JRuby 9.3, but it may be upgraded to 2.7 once JRuby 9.4 comes out.
+- API: Updated endpoints that make a `GET` or `DELETE` requests to not have a `body`. Requests with `PUT` and `POST` now expect most parameters to be in the request body. Parameters that were available as both arguments and in the body are now just in the body.
+- API: An updated generator is being used to generate the endpoint code. The source code documentation has better typing hints for parameters.
+
+[discrete]
+==== Response Object
+
+* Requests now return an `Elastic::API::Response` object. This behaves exactly the same as the previous response (`Elastic::Transport::Transport::Response`) but expands its functionality. With the previous response object, the body of the response had to be accessed calling the `body` method on the response. This new object behaves like the response.body Hash object, except when the `status` or `headers` are sent to it. This makes it easier to access the response data. Example:
+
++
+[source,rb]
+----------------------------
+client = Elastic::EnterpriseSearch::Client.new(
+  host: 'http://localhost:3002',
+  http_auth: {user: 'elastic', password: 'changeme'}
+)
+response = client.health
+response.class
+# => Elastic::API::Response
+response['version']['number']
+# => "8.1.4"
+response.body['version']['number']
+# => "8.1.4"
+response.status
+# => 200
+response.headers
+# =>
+{"date"=>"Tue, 10 May 2022 09:01:10 GMT",
+ "content-type"=>"application/json;charset=utf-8",
+ "etag"=>"W/\"etag--gzip\"",
+ "cache-control"=>"max-age=0, private, must-revalidate",
+ "x-request-id"=>"id",
+ "x-runtime"=>"0.023468",
+ "vary"=>"Accept-Encoding, User-Agent",
+ "content-length"=>"755",
+ "server"=>"Jetty(9.4.43.v20210629)"}
+----------------------------
+
+[discrete]
+==== App Search
+
+[discrete]
+===== API Changes
+
+- API Logs: Removes `date` parameters for filters. This API requires a nested date object under `filters` (now passed in via the body) containing `from` and `to` keys formatted in accordance with RFC3339. The App Search client provides the helper function `date_to_rfc3339` which receives a date String and converts it to the right format.
+- Crawler API : Internal Url updated from `v0` to `v1`. `create_crawler_crawl_rule` body is a required parameter (`order`, `policy`, `rule`, `pattern`). `create_crawler_entry_point` body is required (for `value`). `create_crawler_sitemap` body is required (for `url`). `put_crawler_crawl_rule` body is required (`order`, `policy`, `rule`, `pattern`). `put_crawler_crawl_schedule` body is required (`frequency`, `unit`). `put_crawler_entry_point` body is required (for `value`). `put_crawler_sitemap` body is required (`url`).
+- Curations API: parameters for `create_curation` and `put_curation` must be passed in inside the body parameter now. 
+- Engine APIs: `create_engine` removes the `name` parameter. It must be passed in inside the body parameter now.
+- Log Click: `log_clickthrough` now requires `body`, the parameter `query` and `document_id` are required.
+- Search: When using `search`, query can no longer be sent as an argument. The method will raise `ArgumentError` if no body is sent, since `query` is a required parameter in the body.
+- APIs where `body` has been removed since it's not used: `delete_engine`, `engine`, `list_engines`, `curation`, `delete_curation`, `schema`, `api_key`, `delete_api_key`, `list_api_keys`, `delete_synonym_set`, `list_synonym_set`, `synonym_set`, `list_documents`, `reset_search_settings`, `search_settings`, `crawler_active_crawl_request`, `crawler_crawl_request`, `crawler_crawl_schedule`, `crawler_domain`, `crawler_metrics`, `crawler_overview`, `crawler_process_crawl`, `crawler_process_crawl_denied_urls`, `crawler_user_agent`, `delete_crawler_active_crawl_request`, `delete_crawler_crawl_rule`, `delete_crawler_crawl_schedule`, `delete_crawler_domain`, `delete_crawler_entry_point`, `delete_crawler_sitemap`, `list_crawler_crawl_requests`, `list_crawler_process_crawls`.
+
+[discrete]
+===== New APIs
+
+* `list_crawler_domain`: Lists crawler domains given an engine.
+* Adaptive Relevance Suggestion APIs:
+** `adaptive_relevance_suggestions` - Retrieves adaptive relevance for a single query.
+** `list_adaptive_relevance_suggestions` - List the adaptive relevance suggestions for a given engine.
+** `put_adaptive_relevance_suggestions` - Update adaptive relevance.
+* Adaptive Relevance Settings APIs:
+** `adaptive_relevance_settings` - Retrieve adaptive relevance settings.
+** `put_adaptive_relevance_settings` - Update adaptive relevance settings.
+** `refresh_adaptive_relevance_update_process` - Update suggestions process refresh.
+
+[discrete]
+==== Enterprise Search
+
+- Read-Only API: `put_read_only` body is now required with the enabled object: `{enabled: true|false}`.
+- APIs where `body` has been removed since it's not used: `health`, `read_only`, `stats`, `version`.
+
+[discrete]
+==== Workplace Search
+
+[discrete]
+===== API Changes
+
+* Permissions APIs have been removed: `add_user_permissions`, `list_permissions`, `put_user_permissions`, `remove_user_permissions`, `user_permissions`.
+* `current_user` removed `get_token` parameter.
+* Analytics: `create_analytics_events` will raise ArgumentError if body is missing (Required: type, query_id, page, content_source_id, document_id, rank)
+* Content Sources: `create_content_source` will raise ArgumentError if body is missing (Required: name). `name` cannot be passed in as a parameter anymore, needs to be in the body. `put_content_source` will raise ArgumentError if body is missing (Required: name, is_searchable). `put_content_source_icons` will raise ArgumentError if body is missing.
+* External Identities: `create_external_identity` will raise ArgumentError if body is missing (Required: external_user_id, external_user_properties, permissions). Body parameters have changed:
+
++
+[source,rb]
+----------------------------
+body = {
+  external_user_id: external_user_id,
+  permissions: [],
+  external_user_properties: [
+    'attribute_name' => '_elasticsearch_username',
+    'attribute_value' => 'fernando'
+  ]
+}
+client.create_external_identity(content_source_id, body: body)
+----------------------------
++
+In `delete_external_identity`, `external_identity` and `put_external_identity` the required parameter changed from `user` to `external_user_id`.
+See https://www.elastic.co/guide/en/workplace-search/current/workplace-search-external-identities-api.html
+* Search: Parameters need to be passed in via body to `search`. It will raise ArgumentError if body is missing.
+* Documents: `delete_documents` will raise ArgumentError if body is missing (Required document_ids).
+* Sync Jobs: `command_sync_jobs` will raise ArgumentError if body is missing.
+* Synonyms: `create_batch_synonym_sets`, `put_synonym_set` will raise ArgumentError if body is missing.
+* APIs where `body` has been removed since it's not used: `auto_query_refinement_details`, `content_source`, `current_user`, `delete_content_source`, `delete_external_identity`, `delete_synonym_set`, `document`, `external_identity`, `list_content_sources`, `list_external_identities`, `put_triggers_blocklist`, `synonym_set`, `triggers_blocklist`.
+
+[discrete]
+===== New APIs
+- `list_documents`: Lists documents from a custom content source.

data/docs/guide/release_notes/81.asciidoc

@@ -0,0 +1,8 @@
+[[release_notes_81]]
+=== 8.1.0 Release notes
+
+[discrete]
+==== General
+
+- Tested with Elastic Enterprise Search API version 8.1.0.
+- Tested with Ruby 2.7, 3.0, 3.1, JRuby 9.3. Older versions of Ruby have reached end of life and been removed from the testing matrices. Minimum required Ruby version is Ruby 2.6 to keep compatibility with JRuby 9.3, but it may be upgraded to 2.7 once JRuby 9.4 comes out.

data/docs/guide/release_notes/index.asciidoc

@@ -1,6 +1,10 @@
 [[release_notes]]
 == Release Notes
 
+[discrete]
+=== 8.x
+* <<release_notes_81, 8.1.0 Release Notes>>
+* <<release_notes_80, 8.0.0 Release Notes>>
 
 [discrete]
 === 7.x
@@ -14,6 +18,8 @@
 * <<release_notes_711, 7.11.0 Release Notes>>
 * <<release_notes_710, 7.10.0.beta.1 Release Notes>>
 
+include::81.asciidoc[]
+include::80.asciidoc[]
 include::717.asciidoc[]
 include::716.asciidoc[]
 include::715.asciidoc[]

data/docs/guide/workplace-search-api.asciidoc

@@ -6,10 +6,10 @@
 [source,rb]
 ----------------------------
 # Create a custom content source
-client.create_content_source(name: 'test')
+client.create_content_source(body: { name: 'test' })
 
 # Retrieve a content source by ID
-content_source_id = client.create_content_source(name: 'books').body['id']
+content_source_id = client.create_content_source(body: { name: 'books' }).body['id']
 client.content_source(content_source_id)
 
 # Delete a content source by ID
@@ -139,21 +139,28 @@ client.remove_user_permissions(
 [source,rb]
 ----------------------------
 # Create external identities
-body = { user: 'elastic_user', source_user_id: 'example@elastic.co' }
+body = {
+  external_user_id: external_user_id,
+  permissions: [],
+  external_user_properties: [
+    'attribute_name' => '_elasticsearch_username',
+    'attribute_value' => 'fernando'
+  ]
+}
 client.create_external_identity(content_source_id, body: body)
 
 # Retrieve an external identity
-client.external_identity(content_source_id, user: 'elastic_user')
+client.external_identity(content_source_id, external_user_id: external_user_id)
 
 # List external identities
 client.list_external_identities(content_source_id)
 
 # Update external identity
-body = { source_user_id: 'example2@elastic.co' }
-client.put_external_identity(content_source_id, user: 'elastic_user', body: body)
+body = { external_user_id: external_user_id, permissions: ['permission1'] }
+client.put_external_identity(content_source_id, external_user_id: external_user_id, body: body)
 
 # Delete an external identity
-client.delete_external_identity(content_source_id, user: 'elastic_user')
+client.delete_external_identity(content_source_id, external_user_id: external_user_id)
 ----------------------------
 
 === Search

data/elastic-enterprise-search.gemspec

@@ -22,7 +22,7 @@ require 'elastic/enterprise-search/version'
 
 # rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |s|
-  s.required_ruby_version = '>= 2.5'
+  s.required_ruby_version = '>= 2.6'
   s.name        = 'elastic-enterprise-search'
   s.version     = Elastic::EnterpriseSearch::VERSION
   s.authors     = ['Fernando Briano']
@@ -47,13 +47,13 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_dependency 'elasticsearch-transport', '>= 7.11'
+  s.add_dependency 'elastic-transport', '8.0.0.pre.1'
   s.add_runtime_dependency 'jwt', '>= 1.5', '< 3.0'
   s.add_development_dependency 'awesome_print'
   s.add_development_dependency 'byebug' unless defined?(JRUBY_VERSION)
   s.add_development_dependency 'rspec', '~> 3.9.0'
   s.add_development_dependency 'rspec_junit_formatter'
-  s.add_development_dependency 'rubocop', '~> 1.0.0'
+  s.add_development_dependency 'rubocop', '~> 1'
   s.add_development_dependency 'vcr', '~> 3.0.3'
   s.add_development_dependency 'webmock'
 end

data/lib/elastic/api/response.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elastic
+  module API
+    # Elastic client API Response object. Receives an Elastic::Transport::Transport::Response in
+    # the initializer and behaves like a Hash, except when status or headers are called upon it, in
+    # which case it returns the original object's status and headers.
+    # This class is based on Elasticsearch::API::Response in the Elasticsearch client. For future
+    # versions, we'll want this to live in elastic-transport instead.
+    class Response
+      RESPONSE_METHODS = [:status, :body, :headers].freeze
+
+      def initialize(response)
+        @response = response
+      end
+
+      def method_missing(method, *args, &block)
+        if RESPONSE_METHODS.include? method
+          @response.send method.to_sym
+        else
+          @response.body.send(method.to_sym, *args, &block)
+        end
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        @response.body.respond_to?(method_name, include_private) ||
+          RESPONSE_METHODS.include?(method_name)
+      end
+
+      def to_s
+        @response.body.to_s
+      end
+    end
+  end
+end