elastic-enterprise-search 8.1.1 → 8.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c6b7f543ecfbb56fa72e108d6c86b8aad6c4185e14654ab1e32cc739054073e
-  data.tar.gz: b4692ff93dd20556e6dd8e758577c107c02c2ed0b114bab15aad094ace4dba37
+  metadata.gz: 95fb62ab62fbcabaccdcdbebc1b8caf15fbfe6ca1cec388af5778da738ce0aff
+  data.tar.gz: 1ce82e08b5ab98ea8a0ea47076806b709e765b98b01d6ecb1c1a3284b3660922
 SHA512:
-  metadata.gz: 428fc9ca35fcf144bf83e8ed51d71901f5faf6f8b933c6c5118d95af3aea859b14307c7473b891f49538890f127bfcc5c7980c04531c93ae7f5b22f99a056b72
-  data.tar.gz: 2dde8ce3996c9a6b0ee7e5fef81000ea9397c5c4c1ae0b54e3b61b8fb604508c1727cf61cf4a6ee87c86090e088e8d19e2a02effec877e637e76af74724109e6
+  metadata.gz: 6681c1fb77c29e120cc726345bc97e244aada238720255ad375bf8e6447beb31b4bbeb6283f4153196c6be42f8a807e1b234dd3caa064d5d2fd4da021965e800
+  data.tar.gz: df33f6629dcf8b0ec537b47619fbcce2327cb715a69536df22ed6693429948874c49f2728504a0ae11c351d73020865f77e42ca3addfe0226ba7e1ce570da021

data/.ci/jobs/{elastic+enterprise-search-ruby+7.15.yml → elastic+enterprise-search-ruby+7.17.yml}

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

data/.ci/jobs/{elastic+enterprise-search-ruby+7.16.yml → elastic+enterprise-search-ruby+8.0.yml}

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

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

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

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

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

data/.ci/run-enterprise-search.sh

@@ -54,6 +54,7 @@ docker run \
   --env "elasticsearch.ssl.certificate=/usr/share/app-search/config/certs/testnode.crt" \
   --env "elasticsearch.ssl.certificate_authority=/usr/share/app-search/config/certs/ca.crt" \
   --env "elasticsearch.ssl.key=/usr/share/app-search/config/certs/testnode.key" \
+  --env "ELASTICSEARCH_SEARCH_API=true" \
   --volume $ssl_cert:/usr/share/app-search/config/certs/testnode.crt \
   --volume $ssl_key:/usr/share/app-search/config/certs/testnode.key \
   --volume $ssl_ca:/usr/share/app-search/config/certs/ca.crt \

data/.ci/test-matrix.yml

@@ -5,7 +5,7 @@ RUBY_VERSION:
   - 2.7
 
 STACK_VERSION:
-  - 8.1-SNAPSHOT
+  - 8.3-SNAPSHOT
 
 SERVICE:
   - appsearch

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

@@ -336,6 +336,27 @@ client.put_adaptive_relevance_settings(engine_name, body: body)
 client.refresh_adaptive_relevance_update_process(engine_name, adaptive_relevance_suggestion_type: 'curation')
 ----------------------------
 
+=== Elasticsearch Search
+
+Utilize the API to passthrough and execute raw Elasticsearch queries against the indices that power Enterprise Search engines.
+
+[source,rb]
+----------------------------
+es_request = { body: { query: { bool: { must: { term: { title: 'test' } } } } } }
+client.search_es_search(engine_name, body: { request: es_request })
+----------------------------
+
+=== Search Explain
+
+Submit a search and retrieve an Elasticsearch query.
+
+[source,rb]
+----------------------------
+response = client.search_explain(engine_name, body: { query: 'test' })
+response.body['query_string']
+# => "GET enterprise-search-engine-app-search-explain/_search"
+----------------------------
+
 === Other API Endpoints
 
 [source,rb]

data/docs/guide/connecting.asciidoc

@@ -7,6 +7,7 @@ This page contains the information you need to connect and use the Client with E
 
 * <<authentication>>
 * <<custom_headers>>
+* <<transport>>
 
 
 [discrete]
@@ -168,3 +169,16 @@ workplace_search_client.index_documents(
   { body: documents, headers: headers }
 )
 ----------------------------
+
+[discrete]
+[[transport]]
+=== Transport
+
+The Enterprise Search Ruby client is powered by the https://github.com/elastic/elastic-transport-ruby/[`elastic-transport`] gem. You can read more about it https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/transport.html[here]. The client accepts a transport object as an initializer:
+
+[source,rb]
+----------------------------
+transport = Elastic::Transport::Transport::HTTP::Curb.new
+ent_client = Elastic::EnterpriseSearch::Client.new(transport: transport)
+----------------------------
+

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

@@ -3,6 +3,8 @@
 
 === Health API
 
+Get information on the health of a deployment and basic statistics around resource usage.
+
 [source,rb]
 ----------------------------
 > response = ent_client.health
@@ -17,6 +19,8 @@
 
 === Version API
 
+Get version information for the server.
+
 [source,rb]
 ----------------------------
 > response = ent_client.version
@@ -29,14 +33,16 @@
 [source,rb]
 ----------------------------
 # Set read-only flag state
-ent_client.put_read_only(body: { enabled: false })
+> ent_client.put_read_only(body: { enabled: false })
 
 # Get read-only flag state
-ent_client.read_only
+> ent_client.read_only
 ----------------------------
 
 === Stats API
 
+Get information about the resource usage of the application, the state of different internal queues, etc.
+
 [source,rb]
 ----------------------------
 > ent_client.stats.body
@@ -44,3 +50,12 @@ ent_client.read_only
      "queues"=>{"connectors"=>{...}, "document_destroyer"=>{...}, "engine_destroyer"=>{...}, "index_adder"=>{...}, ...},
      "connectors"=>{"alive"=>true, "pool"=>{...}, "job_store"=>{...}}}}
 ----------------------------
+
+=== Search Engines
+
+Retrieve information about search engines
+
+[source,rb]
+----------------------------
+> ent_client.search_engines
+----------------------------

data/docs/guide/index.asciidoc

@@ -1,4 +1,4 @@
-= enterprise-search-ruby
+= Enterprise Search Ruby client
 
 :doctype: book
 

data/docs/guide/overview.asciidoc

@@ -10,7 +10,9 @@ Current development happens in the main branch.
 
 The library is compatible with all Elastic Enterprise Search versions since `7.x` but you **have to use a matching major version**:
 
-For **Elastic Enterprise Search 7.0** and later, use the major version 7 (`7.x.y`) of the library.
+* For **Elastic Enterprise Search 7.0** and later, use the major version 7 (`7.x.y`) of the library.
+* For **Elastic Enterprise Search 8.0** and later, use the major version 8 (`8.x.y`) of the library.
+
 
 [discrete]
 === HTTP Library
@@ -27,7 +29,7 @@ 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].
+`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://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/transport.html[our official documentation] and  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/82.asciidoc

@@ -0,0 +1,42 @@
+[[release_notes_82]]
+=== 8.2 Release notes
+
+[discrete]
+[[release_notes_821]]
+=== 8.2.1 Release notes
+
+- Adds tracer parameters to enable tracing in elastic-transport. See https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/overview.html#_logging[logging] for more information.
+- Updates Workplace Search OAuth implementation. See https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/workplace-search-api.html#ws-oauth-authentication[OAuth Authentication] for changes in the OAuth process.
+
+[discrete]
+[[release_notes_820]]
+=== 8.2.0 Release notes
+
+[discrete]
+==== General
+
+- Tested with Elastic Enterprise Search API version 8.2.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.
+
+[discrete]
+==== App Search
+[discrete]
+==== New APIs
+
+* Adds Elasticsearch Search API (In Technical Preview): Utilize the API to passthrough and execute raw Elasticsearch queries against the indices that power Enterprise Search engines.
+
++
+[source,rb]
+----------------------------
+es_request = { body: { query: { bool: { must: { term: { title: 'test' } } } } } }
+client.search_es_search(engine_name, body: { request: es_request })
+----------------------------
+
+* Adds Search Explain API: Submit a search and retrieve an Elasticsearch query.
++
+[source,rb]
+----------------------------
+response = client.search_explain(engine_name, body: { query: 'test' })
+response.body['query_string']
+# => "GET enterprise-search-engine-app-search-explain/_search"
+----------------------------

data/docs/guide/release_notes/index.asciidoc

@@ -3,6 +3,8 @@
 
 [discrete]
 === 8.x
+
+* <<release_notes_82, 8.2.0 Release Notes>>
 * <<release_notes_81, 8.1.0 Release Notes>>
 * <<release_notes_80, 8.0.0 Release Notes>>
 
@@ -18,6 +20,7 @@
 * <<release_notes_711, 7.11.0 Release Notes>>
 * <<release_notes_710, 7.10.0.beta.1 Release Notes>>
 
+include::82.asciidoc[]
 include::81.asciidoc[]
 include::80.asciidoc[]
 include::717.asciidoc[]

data/elastic-enterprise-search.gemspec

@@ -47,7 +47,7 @@ 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 'elastic-transport', '8.0.0.pre.1'
+  s.add_dependency 'elastic-transport', '~> 8'
   s.add_runtime_dependency 'jwt', '>= 1.5', '< 3.0'
   s.add_development_dependency 'awesome_print'
   s.add_development_dependency 'byebug' unless defined?(JRUBY_VERSION)

data/lib/elastic/app-search/api/adaptive_relevance_settings.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # AdaptiveRelevanceSettings - Retrieve adaptive relevance settings
         # Retrieve adaptive relevance settings

data/lib/elastic/app-search/api/adaptive_relevance_suggestions.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # AdaptiveRelevanceSuggestions - Retrieve adaptive relevance
         # Retrieve adaptive relevance for a single query
@@ -29,7 +30,7 @@ module Elastic
         # @option arguments [String] :search_suggestion_query Query to obtain suggestions (*Required*)
         # @option arguments [Hash] :body
         # @option body :page
-        # @option body [string] :filters
+        # @option body [Hash] :filters
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-get-engine-adaptive-relevance-suggestions-query

data/lib/elastic/app-search/api/add_meta_engine_source.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Engines - Add a source engine
         # Adds a source engine to a given meta engine

data/lib/elastic/app-search/api/api_key.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Credentials - Retrieve an API key
         # Retrieves details of an API key

data/lib/elastic/app-search/api/api_logs.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # APILogs - Retrieve API logs
         # The API Log displays API request and response data at the Engine level

data/lib/elastic/app-search/api/count_analytics.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Analytics - Query for analytics counts data
         # Returns the number of clicks and total number of queries over a period

data/lib/elastic/app-search/api/crawler_active_crawl_request.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Get active crawl request details
         # Returns active crawl request details.

data/lib/elastic/app-search/api/crawler_crawl_request.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Get crawl request details
         # Returns crawl request details.

data/lib/elastic/app-search/api/crawler_crawl_schedule.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Get crawl schedule
         # Returns the current crawl schedule for a given engine

data/lib/elastic/app-search/api/crawler_domain.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Get domain configuration
         # Returns crawler domain configuration details

data/lib/elastic/app-search/api/crawler_domain_validation_result.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Validate Domain with Crawler
         # Performs a number of checks on a given domain name to make sure it is ready to be crawled and ingested into App Search.

data/lib/elastic/app-search/api/crawler_metrics.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Retrieve a snapshot of crawler metrics
         # Retrieves a momentary snapshot of key crawler metrics, including global and node-level crawler health

data/lib/elastic/app-search/api/crawler_overview.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Retrieve crawler configuration overview
         # Retrieves crawler configuration overview of a given engine, including configured domains

data/lib/elastic/app-search/api/crawler_process_crawl.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Get process crawl details
         # Returns process crawl details.

data/lib/elastic/app-search/api/crawler_process_crawl_denied_urls.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - View denied urls for Process Crawl
         # Provides a sample list of urls identified for deletion by the given process crawl id.

data/lib/elastic/app-search/api/crawler_url_extraction_result.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Extract content from a URL
         # Performs an HTTP request to a given URL and extracts content from the page using standard App Search Crawler extraction pipeline.

data/lib/elastic/app-search/api/crawler_url_tracing_result.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Trace a history of a crawled URL
         # Returns information about the history of a given URL with the App Search Crawler.

data/lib/elastic/app-search/api/crawler_url_validation_result.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Validate URL with Crawler
         # Performs a number of checks on a given URL to make sure it is ready to be crawled and ingested into App Search.

data/lib/elastic/app-search/api/crawler_user_agent.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Get the User-Agent header value for the crawler
         # Retrieves the currently configured value for the User-Agent header used for all Crawler HTTP requests

data/lib/elastic/app-search/api/create_api_key.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Credentials - Create an API key
         # Creates an App Search API key

data/lib/elastic/app-search/api/create_crawler_crawl_request.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Create a crawl request
         # Creates a request to perform a crawl of a given engine with the Crawler.

data/lib/elastic/app-search/api/create_crawler_crawl_rule.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Create a crawl rule
         # Creates a crawl rule for a given engine and domain

data/lib/elastic/app-search/api/create_crawler_domain.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Create a crawler domain
         # Creates a crawler domain configuration for a given engine

data/lib/elastic/app-search/api/create_crawler_entry_point.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Create a crawler entry point
         # Creates a crawler domain entry point for a given engine and domain

data/lib/elastic/app-search/api/create_crawler_process_crawl.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Create a process crawl
         # Queues a task to reprocess crawled documents with current crawl configuration

data/lib/elastic/app-search/api/create_crawler_sitemap.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Create a crawler sitemap
         # Creates a crawler sitemap configuration for a given engine and domain

data/lib/elastic/app-search/api/create_curation.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Curations - Create a new curation
         # Create a new curation for the engine
@@ -31,7 +32,7 @@ module Elastic
         # @option body [Array<string>] :queries List of affected search queries
         # @option body [Array<string>] :promoted List of promoted document IDs
         # @option body [Array<string>] :hidden List of hidden document IDs
-        # @option body [Hash] :suggestion
+        # @option body :suggestion
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/curations.html#curations-create

data/lib/elastic/app-search/api/create_engine.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Engines - Create an Engine
         # Creates an App Search Engine

data/lib/elastic/app-search/api/create_synonym_set.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Synonyms - Create a synonym set
         # Creates a new synonym set for the engine

data/lib/elastic/app-search/api/curation.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Curations - Retrieve a curation
         # Retrieves a curation by ID

data/lib/elastic/app-search/api/delete_api_key.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Credentials - Delete an API key
         # Deletes a given API key

data/lib/elastic/app-search/api/delete_crawler_active_crawl_request.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Cancel an active crawl request
         # Cancels an active crawl request, stopping a running crawl if needed.

data/lib/elastic/app-search/api/delete_crawler_crawl_rule.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Delete a crawl rule
         # Deletes a crawl rule from a given domain

data/lib/elastic/app-search/api/delete_crawler_crawl_schedule.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Delete a crawl schedule
         # Deletes a crawl schedule for a given engine

data/lib/elastic/app-search/api/delete_crawler_domain.rb

@@ -20,6 +20,7 @@
 module Elastic
   module EnterpriseSearch
     module AppSearch
+      # Generated from build hash 835a1a87f357f7b7cfd3453b5c5a937c47995772
       module Actions
         # Crawler - Delete domain configuration
         # Deletes crawler domain configuration for a given domain