elastic-enterprise-search 7.16.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3331736a101d1b938e0911742b67fe42a42849e179e8f5b575f9f2b07dafda2
-  data.tar.gz: 3ef839006353cd13259ec36ddf0244c2c6812f19add3a04b48dd169e2d66238c
+  metadata.gz: fe3de694901dc1b16bef977ae8e1c5fbe17da770daa14cf59fbbe3c46588331a
+  data.tar.gz: ca7d3672c8d91810d5ae0589f444ebc3992b7cb4673729b7c45e1e3184a43555
 SHA512:
-  metadata.gz: 5f1d529bdbd13f0c550bee3f475ee799ec537e39ffc172b18119a194fe61c27a8452c56e1cd1ee8cb68a6d60fb56da92bc4cadad82d35650119df7ef21647e09
-  data.tar.gz: 36465dbde68f27f1d39a7afb829e890e6ccda5c6b4fce70186ecc229ada201de89a13fbbd198d2c6a5b483ac4e4e5c28abd516633d5a45c7b241bc2ecc92d6ff
+  metadata.gz: 580b81ecdca1b5e7522b3a5b54e237b29bccad3d99b93af9161c0f54196e4960436208b463f7dd6b416faef68e048c4c1b7bb4efe1429fcf7601184b0df35384
+  data.tar.gz: 05d5729c7254f93b0ca8b77a4400195b72854bf9973c2a499b23b90b2ecae8c20d82dc97fa68f2a05a7947305deab8d0578b92fc89b224a8c23395fdedfb0388

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

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

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

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

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

@@ -1,12 +1,11 @@
 ---
 RUBY_VERSION:
+  - 3.1
   - 3.0
   - 2.7
-  - 2.6
-  - 2.5
 
 STACK_VERSION:
-  - 7.16-SNAPSHOT
+  - 8.0-SNAPSHOT
 
 SERVICE:
   - appsearch

data/.github/workflows/testing.yml

@@ -1,4 +1,4 @@
-name: 7.x
+name: main
 on: [push, pull_request]
 
 jobs:
@@ -7,7 +7,7 @@ jobs:
       ENDPOINT: http://localhost:8080
     strategy:
       matrix:
-        ruby: [ 2.5, 2.6, 2.7, 3.0 ]
+        ruby: [ 2.7, 3.0, 3.1 ]
 
     runs-on: ubuntu-latest
     steps:
@@ -26,7 +26,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]
@@ -304,28 +303,37 @@ client.crawler_process_crawl_denied_urls(engine_name, process_crawl_id: id)
 # Cancel an active crawl request, stopping a running crawl if needed.
 client.delete_crawler_active_crawl_request(engine_name)
 ----------------------------
-=== Adaptive Relevance
-
 
-The adaptive relevance 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. The adaptive relevance API is not available at all Elastic subscription levels. Refer to the Elastic subscriptions pages for https://www.elastic.co/subscriptions/cloud[Elastic Cloud] and https://www.elastic.co/subscriptions[self-managed] deployments.
+=== Adaptive Relevance Suggestions
 
 [source,rb]
 ----------------------------
-# Retrieve adaptive relevance settings
-client.adaptive_relevance_settings(engine_name)
+# Update an adaptive relevance suggestion
+body = [{ query: 'forest', type: 'curation', status: 'applied' }]
+client.put_adaptive_relevance_suggestions(engine_name, body: body)
 
-# Update adaptive relevance settings for an engine
-body = { curation: { enabled: true } }
-client.put_adaptive_relevance_settings(engine_name, body: body)
+# Retrieve an adaptive relevance suggestion
+client.adaptive_relevance_suggestions(engine_name, search_suggestion_query: 'test')
 
-# List suggestions
+# List adaptive relevance suggestions
 client.list_adaptive_relevance_suggestions(engine_name)
+----------------------------
 
-# Update adaptive relevance
-client.put_adaptive_relevance_suggestions(engine_name, body: body)
+=== 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)
 
-# Retrive adaptive relevance
-client.adaptive_relevance_suggestions(engine_name, search_suggestion_query: 'suggestion')
+# Refresh adaptive relevance update process
+client.refresh_adaptive_relevance_update_process(engine_name, adaptive_relevance_suggestion_type: 'curation')
 ----------------------------
 
 === Other API Endpoints

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/714.asciidoc

@@ -1,16 +1,4 @@
 [[release_notes_714]]
-=== 7.14 Release notes
-
-[discrete]
-[[release_notes_7141]]
-=== 7.14.1 Release notes
-
-==== Dependency fix
-
-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.
-
-[discrete]
-[[release_notes_7140]]
 === 7.14.0 Release notes
 
 [discrete]

data/docs/guide/release_notes/715.asciidoc

@@ -1,16 +1,4 @@
 [[release_notes_715]]
-=== 7.15 Release notes
-
-[discrete]
-[[release_notes_7151]]
-=== 7.15.1 Release notes
-
-==== Dependency fix
-
-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.
-
-[discrete]
-[[release_notes_7150]]
 === 7.15.0 Release notes
 
 [discrete]

data/docs/guide/release_notes/717.asciidoc

@@ -0,0 +1,9 @@
+[[release_notes_717]]
+=== 7.17 Release notes
+
+[discrete]
+==== General
+
+- Tested with Elastic Enterprise Search API version 7.17.0.
+- Last release in the `7.x` branch.
+- Tested with Ruby 2.6, 2.7, 3.0, 3.1

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/index.asciidoc

@@ -1,10 +1,14 @@
 [[release_notes]]
 == Release Notes
 
+[discrete]
+=== 8.x
+* <<release_notes_80, 8.0.0 Release Notes>>
 
 [discrete]
 === 7.x
 
+* <<release_notes_717, 7.17.0 Release Notes>>
 * <<release_notes_716, 7.16.0 Release Notes>>
 * <<release_notes_715, 7.15.0 Release Notes>>
 * <<release_notes_714, 7.14.0 Release Notes>>
@@ -13,6 +17,8 @@
 * <<release_notes_711, 7.11.0 Release Notes>>
 * <<release_notes_710, 7.10.0.beta.1 Release Notes>>
 
+include::80.asciidoc[]
+include::717.asciidoc[]
 include::716.asciidoc[]
 include::715.asciidoc[]
 include::714.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