elastic-enterprise-search 7.17.0 → 8.0.1

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
@@ -76,22 +76,42 @@ client.delete_documents_by_query(content_source_id, query: query)
 [[ws-oauth-authentication]]
 === OAuth Authentication
 
-You need to configure the OAuth Application for Search in order to use the Workplace Search client's `search` and `create_analytics` endpoints. You need to follow the steps in https://www.elastic.co/guide/en/workplace-search/current/building-custom-search-workplace-search.html#configuring-search-oauth[Configuring the OAuth Application for Search] to retrieve the credentials: Client ID and Client Secret to request access tokens from the authentication server.
+You need to configure the OAuth Application for Search in order to use the Workplace Search client's `search` and `create_analytics` endpoints. You need to follow the steps in https://www.elastic.co/guide/en/workplace-search/current/building-custom-search-workplace-search.html#configuring-search-oauth[Configuring the OAuth Application for Search] to retrieve the credentials: **Client ID** and **Client Secret** to request access tokens from the authentication server.
+
+The client implements https://www.elastic.co/guide/en/workplace-search/current/building-custom-search-workplace-search.html#authenticating-search-user-confidential[Authenticating Users with a Confidential OAuth Flow]. It provides a helper to obtain the autorization URL directly from the client once you've set the necessary values.
+
+The authorization endpoint is hosted by your Kibana deployment, so you need to provide the client with the https://www.elastic.co/guide/en/enterprise-search/current/endpoints-ref.html#kibana-base-url[base URL of your Kibana instance]. You can do this when you initialize the client:
+
+[source,rb]
+----------------------------
+client = Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(http_auth: <access_token>, kibana_url: <kibana_url>)
+----------------------------
+
+Or you can set in an existing client:
 
 [source,rb]
 ----------------------------
 client = Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(http_auth: <access_token>)
+client.kibana_url = <kibana_url>
+----------------------------
 
+Once you've instantiated a client and the base URL of your Kibana instance is set, you can get the URL for authorization like so:
+[source,rb]
+----------------------------
+# You get the values for client_id and client_secret when configuring the OAuth Application:
 client_id = <client_id>
 client_secret = <client_secret>
 redirect_uri = <redirect_uri>
 
 # Get the authorization URL:
 client.authorization_url(client_id, redirect_uri)
-> https://host:port/ws/oauth/authorize?response_type=code&client_id=client_id&redirect_uri=https%3A%2F%2Flocalhost%3A3002
+> https://kibana_url/app/enterprise_search/workplace_search/p/oauth/authorize?response_type=code&client_id=client_id&redirect_uri=https%3A%2F%2Flocalhost%3A3002
+
 ----------------------------
 
-Open the URL to authorize your application. Successful authorization redirects the user in accordance to the redirect URI provided (and configured for the application). The application server must now request for an access_token, which is generated by Workplace Search using the oauth/token endpoint, using the Client ID and Client Secret.
+Open the URL to authorize your application. Successful authorization redirects the user in accordance to the redirect URI provided (and configured for the application).
+
+The application server must now request for an `access_token`, which is generated by Workplace Search using the `oauth/token` endpoint, using the **Client ID** and **Client Secret**.
 
 [source,rb]
 ----------------------------
@@ -100,7 +120,7 @@ authorization_code = '<paste code from redirect>'
 access_token = client.request_access_token(client_id, client_secret, authorization_code, redirect_uri)
 
 # The access_token can now be used to issue a search request:
-client.search(body: {query: 'search query'}, access_token: access_token)
+client.search(body: { query: 'search query' }, access_token: access_token)
 ----------------------------
 
 See https://www.elastic.co/guide/en/workplace-search/current/workplace-search-search-api.html#search-api-overview[Search API Overview] for more search parameters.
@@ -139,21 +159,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

data/lib/elastic/{workplace-search/api/user_permissions.rb → app-search/api/adaptive_relevance_settings.rb}

@@ -19,31 +19,26 @@
 
 module Elastic
   module EnterpriseSearch
-    module WorkplaceSearch
+    module AppSearch
       module Actions
-        # Permissions - Lists all permissions for one user
-        # List permissions for a user
+        # AdaptiveRelevanceSettings - Retrieve adaptive relevance settings
+        # Retrieve adaptive relevance settings
         #
-        # @param content_source_id [String] Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [String] :user The username in context (*Required*)
+        # @param [String] engine_name Name of the engine (*Required*)
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
-        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-document-permissions-api.html#list-one
+        # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-get-engine-adaptive-relevance-settings
         #
-        def user_permissions(content_source_id, arguments = {})
-          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
-          raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
-
-          user = arguments[:user]
+        def adaptive_relevance_settings(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           headers = arguments.delete(:headers) || {}
-
           request(
             :get,
-            "api/ws/v1/sources/#{content_source_id}/permissions/#{user}/",
+            "api/as/v0/engines/#{engine_name}/adaptive_relevance/settings/",
             arguments,
-            {},
+            nil,
             headers
           )
         end

data/lib/elastic/{workplace-search/api/add_user_permissions.rb → app-search/api/adaptive_relevance_suggestions.rb}

@@ -19,30 +19,36 @@
 
 module Elastic
   module EnterpriseSearch
-    module WorkplaceSearch
+    module AppSearch
       module Actions
-        # Permissions - Adds one or more new permissions atop existing permissions
-        # Add one or more permission for a given user. Permissions are added atop the existing
+        # AdaptiveRelevanceSuggestions - Retrieve adaptive relevance
+        # Retrieve adaptive relevance for a single query
         #
-        # @param content_source_id [String] Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [String] :user The username in context (*Required*)
-        # @option arguments [Array] :body List of permissions
+        # @param [String] engine_name Name of the engine (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [String] :search_suggestion_query Query to obtain suggestions (*Required*)
+        # @option arguments [Hash] :body
+        # @option body :page
+        # @option body [string] :filters
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
-        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-document-permissions-api.html#add-one
+        # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-get-engine-adaptive-relevance-suggestions-query
         #
-        def add_user_permissions(content_source_id, arguments = {})
-          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
-          raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
+        def adaptive_relevance_suggestions(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
-          user = arguments[:user]
+          unless arguments[:search_suggestion_query]
+            raise ArgumentError,
+                  "Required parameter 'search_suggestion_query' missing"
+          end
+
+          search_suggestion_query = arguments.delete(:search_suggestion_query)
           body = arguments.delete(:body) || {}
-          headers = arguments.delete(:headers) || {}
 
+          headers = arguments.delete(:headers) || {}
           request(
             :post,
-            "api/ws/v1/sources/#{content_source_id}/permissions/#{user}/add/",
+            "api/as/v0/engines/#{engine_name}/adaptive_relevance/suggestions/#{search_suggestion_query}/",
             arguments,
             body,
             headers

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

@@ -24,20 +24,19 @@ module Elastic
         # Engines - Add a source engine
         # Adds a source engine to a given meta engine
         #
-        # @param engine_name [String] Name of the engine (*Required*)
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [Array] :source_engines List of engine names (*Required*)
+        # @param [String] engine_name Name of the engine (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [Array<String>] :source_engines
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/meta-engines.html#meta-engines-add-source-engines
         #
         def add_meta_engine_source(engine_name, arguments = {})
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
-          raise ArgumentError, "Required parameter 'source_engines' missing" unless arguments[:source_engines]
 
           source_engines = arguments.delete(:source_engines) || {}
-          headers = arguments.delete(:headers) || {}
 
+          headers = arguments.delete(:headers) || {}
           request(
             :post,
             "api/as/v1/engines/#{engine_name}/source_engines/",

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

@@ -24,9 +24,8 @@ module Elastic
         # Credentials - Retrieve an API key
         # Retrieves details of an API key
         #
-        # @param arguments [Hash] endpoint arguments
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [String] :api_key_name Name of an API key (*Required*)
-        # @option arguments [Hash] :body The request body
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/credentials.html#credentials-single
@@ -34,15 +33,14 @@ module Elastic
         def api_key(arguments = {})
           raise ArgumentError, "Required parameter 'api_key_name' missing" unless arguments[:api_key_name]
 
-          api_key_name = arguments[:api_key_name]
-          body = arguments.delete(:body) || {}
-          headers = arguments.delete(:headers) || {}
+          api_key_name = arguments.delete(:api_key_name)
 
+          headers = arguments.delete(:headers) || {}
           request(
             :get,
             "api/as/v1/credentials/#{api_key_name}/",
             arguments,
-            body,
+            nil,
             headers
           )
         end

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

@@ -24,31 +24,24 @@ module Elastic
         # APILogs - Retrieve API logs
         # The API Log displays API request and response data at the Engine level
         #
-        # @param engine_name [String] Name of the engine (*Required*)
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [Date] :from_date Filter date from (*Required*)
-        # @option arguments [Date] :to_date Filter date to (*Required*)
-        # @option arguments [Hash] :body
-        # @option body [String] :query You can search over the full_request_path of an API Log event. Use this to specify a particular endpoint, like analytics, search, curations and so on.
-        # @option body [String] :sort_direction Would you like to have your results ascending, oldest to newest, or descending, newest to oldest? Accepts asc or desc. Defaults to ascending.
-        # @option body [Integer] :page current for current page, total_pages for the net number of pages, total_results for the overall number of results, size for the amount of results per page.
+        # @param [String] engine_name Name of the engine (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [Hash] :body (Required: filters)
         # @option body :filters
-        # @option filters [String] :status Filter based on a particular status code: 400, 401, 403, 429, 200
-        # @option filters [String] :method Filter based on a particular HTTP method: GET, POST, PUT, PATCH, DELETE
+        # @option body :page
+        # @option body [string] :query
+        # @option body :sort_direction
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/api-logs.html
         #
         def api_logs(engine_name, arguments = {})
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
-          raise ArgumentError, "Required parameter 'from_date' missing" unless arguments[:from_date]
-          raise ArgumentError, "Required parameter 'to_date' missing" unless arguments[:to_date]
+          raise ArgumentError, "Required parameter 'body (filters)' missing" unless arguments[:body]
 
           body = arguments.delete(:body) || {}
-          headers = arguments.delete(:headers) || {}
-          arguments['filters[date][from]'] = date_to_rfc3339(arguments.delete(:from_date))
-          arguments['filters[date][to]'] = date_to_rfc3339(arguments.delete(:to_date))
 
+          headers = arguments.delete(:headers) || {}
           request(
             :post,
             "api/as/v1/engines/#{engine_name}/logs/api/",

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

@@ -24,11 +24,11 @@ module Elastic
         # Analytics - Query for analytics counts data
         # Returns the number of clicks and total number of queries over a period
         #
-        # @param engine_name [String] Name of the engine (*Required*)
-        # @param arguments [Hash] endpoint arguments
+        # @param [String] engine_name Name of the engine (*Required*)
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [Hash] :body
-        # @option body :filters Analytics filters
-        # @option body [String] :interval You can define an interval along with your date range. Can be either hour or day
+        # @option body :filters
+        # @option body [string] :interval
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/counts.html
@@ -37,8 +37,8 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
-          headers = arguments.delete(:headers) || {}
 
+          headers = arguments.delete(:headers) || {}
           request(
             :post,
             "api/as/v1/engines/#{engine_name}/analytics/counts/",

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

@@ -24,9 +24,8 @@ module Elastic
         # Crawler - Get active crawl request details
         # Returns active crawl request details.
         #
-        # @param engine_name [String] Name of the engine (*Required*)
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [Hash] :body The request body
+        # @param [String] engine_name Name of the engine (*Required*)
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-crawl-requests-active
@@ -34,14 +33,12 @@ module Elastic
         def crawler_active_crawl_request(engine_name, arguments = {})
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
-          body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :get,
-            "api/as/v0/engines/#{engine_name}/crawler/crawl_requests/active/",
+            "api/as/v1/engines/#{engine_name}/crawler/crawl_requests/active/",
             arguments,
-            body,
+            nil,
             headers
           )
         end

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

@@ -24,10 +24,9 @@ module Elastic
         # Crawler - Get crawl request details
         # Returns crawl request details.
         #
-        # @param engine_name [String] Name of the engine (*Required*)
-        # @param arguments [Hash] endpoint arguments
+        # @param [String] engine_name Name of the engine (*Required*)
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [String] :crawl_request_id Crawl Request ID (*Required*)
-        # @option arguments [Hash] :body The request body
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-crawl-requests-id
@@ -36,15 +35,14 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
           raise ArgumentError, "Required parameter 'crawl_request_id' missing" unless arguments[:crawl_request_id]
 
-          crawl_request_id = arguments[:crawl_request_id]
-          body = arguments.delete(:body) || {}
-          headers = arguments.delete(:headers) || {}
+          crawl_request_id = arguments.delete(:crawl_request_id)
 
+          headers = arguments.delete(:headers) || {}
           request(
             :get,
-            "api/as/v0/engines/#{engine_name}/crawler/crawl_requests/#{crawl_request_id}/",
+            "api/as/v1/engines/#{engine_name}/crawler/crawl_requests/#{crawl_request_id}/",
             arguments,
-            body,
+            nil,
             headers
           )
         end

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

@@ -24,9 +24,8 @@ module Elastic
         # Crawler - Get crawl schedule
         # Returns the current crawl schedule for a given engine
         #
-        # @param engine_name [String] Name of the engine (*Required*)
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [Hash] :body The request body
+        # @param [String] engine_name Name of the engine (*Required*)
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-crawl-schedule
@@ -34,14 +33,12 @@ module Elastic
         def crawler_crawl_schedule(engine_name, arguments = {})
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
-          body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :get,
-            "api/as/v0/engines/#{engine_name}/crawler/crawl_schedule/",
+            "api/as/v1/engines/#{engine_name}/crawler/crawl_schedule/",
             arguments,
-            body,
+            nil,
             headers
           )
         end

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

@@ -24,10 +24,9 @@ module Elastic
         # Crawler - Get domain configuration
         # Returns crawler domain configuration details
         #
-        # @param engine_name [String] Name of the engine (*Required*)
-        # @param arguments [Hash] endpoint arguments
+        # @param [String] engine_name Name of the engine (*Required*)
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [String] :domain_id Crawler Domain ID (*Required*)
-        # @option arguments [Hash] :body The request body
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-domain
@@ -36,15 +35,14 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
           raise ArgumentError, "Required parameter 'domain_id' missing" unless arguments[:domain_id]
 
-          domain_id = arguments[:domain_id]
-          body = arguments.delete(:body) || {}
-          headers = arguments.delete(:headers) || {}
+          domain_id = arguments.delete(:domain_id)
 
+          headers = arguments.delete(:headers) || {}
           request(
             :get,
-            "api/as/v0/engines/#{engine_name}/crawler/domains/#{domain_id}/",
+            "api/as/v1/engines/#{engine_name}/crawler/domains/#{domain_id}/",
             arguments,
-            body,
+            nil,
             headers
           )
         end

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

@@ -24,19 +24,20 @@ module Elastic
         # 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.
         #
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [String] :body
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [string] :body
+        # @option body [string] :url *Required*
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
-        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html
+        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawler-validate-domain
         #
         def crawler_domain_validation_result(arguments = {})
           body = arguments.delete(:body) || {}
-          headers = arguments.delete(:headers) || {}
 
+          headers = arguments.delete(:headers) || {}
           request(
             :post,
-            'api/as/v0/crawler/validate_url/',
+            'api/as/v1/crawler/validate_url/',
             arguments,
             body,
             headers

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

@@ -24,21 +24,18 @@ module Elastic
         # Crawler - Retrieve a snapshot of crawler metrics
         # Retrieves a momentary snapshot of key crawler metrics, including global and node-level crawler health
         #
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [Hash] :body The request body
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html
         #
         def crawler_metrics(arguments = {})
-          body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :get,
-            'api/as/v0/crawler/metrics/',
+            'api/as/v1/crawler/metrics/',
             arguments,
-            body,
+            nil,
             headers
           )
         end

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

@@ -24,9 +24,8 @@ module Elastic
         # Crawler - Retrieve crawler configuration overview
         # Retrieves crawler configuration overview of a given engine, including configured domains
         #
-        # @param engine_name [String] Name of the engine (*Required*)
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [Hash] :body The request body
+        # @param [String] engine_name Name of the engine (*Required*)
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler
@@ -34,14 +33,12 @@ module Elastic
         def crawler_overview(engine_name, arguments = {})
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
-          body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :get,
-            "api/as/v0/engines/#{engine_name}/crawler/",
+            "api/as/v1/engines/#{engine_name}/crawler/",
             arguments,
-            body,
+            nil,
             headers
           )
         end

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

@@ -24,10 +24,9 @@ module Elastic
         # Crawler - Get process crawl details
         # Returns process crawl details.
         #
-        # @param engine_name [String] Name of the engine (*Required*)
-        # @param arguments [Hash] endpoint arguments
+        # @param [String] engine_name Name of the engine (*Required*)
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [String] :process_crawl_id Process Crawl identifier (*Required*)
-        # @option arguments [Hash] :body The request body
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-process-crawls-id
@@ -36,15 +35,14 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
           raise ArgumentError, "Required parameter 'process_crawl_id' missing" unless arguments[:process_crawl_id]
 
-          process_crawl_id = arguments[:process_crawl_id]
-          body = arguments.delete(:body) || {}
-          headers = arguments.delete(:headers) || {}
+          process_crawl_id = arguments.delete(:process_crawl_id)
 
+          headers = arguments.delete(:headers) || {}
           request(
             :get,
-            "api/as/v0/engines/#{engine_name}/crawler/process_crawls/#{process_crawl_id}/",
+            "api/as/v1/engines/#{engine_name}/crawler/process_crawls/#{process_crawl_id}/",
             arguments,
-            body,
+            nil,
             headers
           )
         end