elastic-enterprise-search 7.10.0.beta.1 → 7.11.0

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

@@ -25,21 +25,24 @@ module Elastic
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option body - The request body
-        #
+        # @option arguments [Array] :documents List of document to index (*Required*)
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/documents.html#documents-create
         #
         def index_documents(engine_name, arguments = {})
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'documents' missing" unless arguments[:documents]
 
-          body = arguments.delete(:body) || {}
+          documents = arguments.delete(:documents) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :post,
             "api/as/v1/engines/#{engine_name}/documents/",
             arguments,
-            body
+            documents,
+            headers
           )
         end
       end

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

@@ -25,10 +25,10 @@ module Elastic
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option current_page [String] The page to fetch. Defaults to 1
-        # @option page_size [String] The number of results per page
-        # @option body - The request body
-        #
+        # @option arguments [String] :current_page The page to fetch. Defaults to 1
+        # @option arguments [String] :page_size The number of results per page
+        # @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/curations.html#curations-read
         #
@@ -36,12 +36,14 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :get,
             "api/as/v1/engines/#{engine_name}/curations/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

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

@@ -25,10 +25,10 @@ module Elastic
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option current_page [String] The page to fetch. Defaults to 1
-        # @option page_size [String] The number of results per page
-        # @option body - The request body
-        #
+        # @option arguments [String] :current_page The page to fetch. Defaults to 1
+        # @option arguments [String] :page_size The number of results per page
+        # @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/documents.html#documents-list
         #
@@ -36,12 +36,14 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :get,
             "api/as/v1/engines/#{engine_name}/documents/list/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

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

@@ -24,21 +24,23 @@ module Elastic
         # Engine - Retrieves all engines with optional pagination support
         #
         # @param arguments [Hash] endpoint arguments
-        # @option current_page [String] The page to fetch. Defaults to 1
-        # @option page_size [String] The number of results per page
-        # @option body - The request body
-        #
+        # @option arguments [String] :current_page The page to fetch. Defaults to 1
+        # @option arguments [String] :page_size The number of results per page
+        # @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/engines.html#engines-list
         #
         def list_engines(arguments = {})
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :get,
             'api/as/v1/engines/',
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

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

@@ -25,10 +25,10 @@ module Elastic
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option current_page [String] The page to fetch. Defaults to 1
-        # @option page_size [String] The number of results per page
-        # @option body - The request body
-        #
+        # @option arguments [String] :current_page The page to fetch. Defaults to 1
+        # @option arguments [String] :page_size The number of results per page
+        # @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/synonyms.html#synonyms-get
         #
@@ -36,12 +36,14 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :get,
             "api/as/v1/engines/#{engine_name}/synonyms/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

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

@@ -25,12 +25,12 @@ module Elastic
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option query_text [String] Search query text (*Required*)
-        # @option document_id [] The ID of the document that was clicked on (*Required*)
-        # @option request_id [String] The request ID returned in the meta tag of a search API response
-        # @option tags [Array] Array of strings representing additional information you wish to track with the clickthrough
-        # @option body - The request body
-        #
+        # @option arguments [String] :query_text Search query text (*Required*)
+        # @option arguments :document_id The ID of the document that was clicked on (*Required*)
+        # @option arguments [String] :request_id The request ID returned in the meta tag of a search API response
+        # @option arguments [Array] :tags Array of strings representing additional information you wish to track with the clickthrough
+        # @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/clickthrough.html
         #
@@ -40,12 +40,15 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+          arguments['query'] = arguments.delete(:query_text)
 
           request(
             :post,
             "api/as/v1/engines/#{engine_name}/click/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

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

@@ -25,23 +25,24 @@ module Elastic
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option queries [] Search queries (*Required*)
-        # @option body - The request body
+        # @option arguments [Object] :queries One or more queries to execute in parallel (*Required*)
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
-        #
-        # @see https://www.elastic.co/guide/en/app-search/current/search.html#search-multi
+        # @see https://www.elastic.co/guide/en/app-search/current/multi-search.html
         #
         def multi_search(engine_name, arguments = {})
-          raise ArgumentError, "Required parameter 'queries' missing" unless arguments[:queries]
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'queries' missing" unless arguments[:queries]
 
-          body = arguments.delete(:body) || {}
+          queries = arguments.delete(:queries) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :post,
             "api/as/v1/engines/#{engine_name}/multi_search/",
             arguments,
-            body
+            queries,
+            headers
           )
         end
       end

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

@@ -25,12 +25,12 @@ module Elastic
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option queries [Array] List of affected search queries (*Required*)
-        # @option curation_id [String]  (*Required*)
-        # @option promoted_doc_ids [] List of promoted document IDs
-        # @option hidden_doc_ids [] List of hidden document IDs
-        # @option body - The request body
-        #
+        # @option arguments [Array] :queries List of affected search queries (*Required*)
+        # @option arguments [String] :curation_id  (*Required*)
+        # @option arguments :promoted_doc_ids List of promoted document IDs
+        # @option arguments :hidden_doc_ids List of hidden document IDs
+        # @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/curations.html#curations-update
         #
@@ -40,14 +40,15 @@ module Elastic
           raise ArgumentError, "Required parameter 'curation_id' missing" unless arguments[:curation_id]
 
           curation_id = arguments[:curation_id]
-
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :put,
             "api/as/v1/engines/#{engine_name}/curations/#{curation_id}/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

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

@@ -25,21 +25,24 @@ module Elastic
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option body - The request body
-        #
+        # @option arguments [Array] :documents List of documents to update (*Required*)
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/documents.html#documents-partial
         #
         def put_documents(engine_name, arguments = {})
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'documents' missing" unless arguments[:documents]
 
-          body = arguments.delete(:body) || {}
+          documents = arguments.delete(:documents) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :patch,
             "api/as/v1/engines/#{engine_name}/documents/",
             arguments,
-            body
+            documents,
+            headers
           )
         end
       end

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

@@ -25,21 +25,24 @@ module Elastic
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option body - The request body
-        #
+        # @option arguments [Object] :schema Schema description (*Required*)
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/schema.html#schema-patch
         #
         def put_schema(engine_name, arguments = {})
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'schema' missing" unless arguments[:schema]
 
-          body = arguments.delete(:body) || {}
+          schema = arguments.delete(:schema) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :post,
             "api/as/v1/engines/#{engine_name}/schema/",
             arguments,
-            body
+            schema,
+            headers
           )
         end
       end

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

@@ -25,21 +25,24 @@ module Elastic
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option body - The request body
-        #
+        # @option arguments [Object] :body Search settings (*Required*)
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/search-settings.html#search-settings-update
         #
         def put_search_settings(engine_name, arguments = {})
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'body' missing" unless arguments[:body]
 
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :put,
             "api/as/v1/engines/#{engine_name}/search_settings/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

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

@@ -25,27 +25,27 @@ module Elastic
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option synonyms [] List of synonyms words (*Required*)
-        # @option synonym_set_id [String]  (*Required*)
-        # @option body - The request body
-        #
+        # @option arguments [String] :synonym_set_id  (*Required*)
+        # @option arguments [Object] :body Synonym set description (*Required*)
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/synonyms.html#synonyms-update
         #
         def put_synonym_set(engine_name, arguments = {})
-          raise ArgumentError, "Required parameter 'synonyms' missing" unless arguments[:synonyms]
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
           raise ArgumentError, "Required parameter 'synonym_set_id' missing" unless arguments[:synonym_set_id]
+          raise ArgumentError, "Required parameter 'body' missing" unless arguments[:body]
 
           synonym_set_id = arguments[:synonym_set_id]
-
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :put,
             "api/as/v1/engines/#{engine_name}/synonyms/#{synonym_set_id}/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

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

@@ -25,11 +25,11 @@ module Elastic
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option query [String] A partial query for which to receive suggestions (*Required*)
-        # @option fields [Array] List of fields to use to generate suggestions. Defaults to all text fields
-        # @option size [Integer] Number of query suggestions to return. Must be between 1 and 20. Defaults to 5
-        # @option body - The request body
-        #
+        # @option arguments [String] :query A partial query for which to receive suggestions (*Required*)
+        # @option arguments [Array] :fields List of fields to use to generate suggestions. Defaults to all text fields
+        # @option arguments [Integer] :size Number of query suggestions to return. Must be between 1 and 20. Defaults to 5
+        # @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/query-suggestion.html
         #
@@ -38,12 +38,14 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :post,
             "api/as/v1/engines/#{engine_name}/query_suggestion/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

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

@@ -25,8 +25,8 @@ module Elastic
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option body - The request body
-        #
+        # @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/search-settings.html#search-settings-reset
         #
@@ -34,12 +34,14 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :post,
             "api/as/v1/engines/#{engine_name}/search_settings/reset/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

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

@@ -21,12 +21,12 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Schema - Retrieve current schema for then engine
+        # Schema - Retrieve current schema for the engine
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option body - The request body
-        #
+        # @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/schema.html#schema-read
         #
@@ -34,12 +34,14 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :get,
             "api/as/v1/engines/#{engine_name}/schema/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end