elastic-enterprise-search 7.17.0 → 8.0.1

data/lib/elastic/workplace-search/api/create_content_source.rb

@@ -24,12 +24,12 @@ module Elastic
         # ContentSources - Create a content source
         # Create a custom content source
         #
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [Hash] :body Definition to create a Workplace Search Content Source (Required: name)
-        # @option body [String] :name The human readable display name for this Content Source. (*Required)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [Hash] :body (Required: name)
+        # @option body [string] :name The human readable display name for this Content Source.
         # @option body :schema The schema that each document in this Content Source will adhere to.
         # @option body :display The display details which governs which fields will be displayed, and in what order, in the search results.
-        # @option body [Boolean] :is_searchable Whether or not this Content Source will be searchable on the search page.
+        # @option body [boolean] :is_searchable Whether or not this Content Source will be searchable on the search page.
         # @option body :indexing
         # @option body :facets
         # @option body :automatic_query_refinement
@@ -38,9 +38,10 @@ module Elastic
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-content-sources-api.html#create-content-source-api
         #
         def create_content_source(arguments = {})
+          raise ArgumentError, "Required parameter 'body (name)' missing" unless arguments[:body]
+
           body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :post,
             'api/ws/v1/sources/',

data/lib/elastic/workplace-search/api/create_external_identity.rb

@@ -24,11 +24,12 @@ module Elastic
         # ExternalIdentities - Adds a new external identity
         # Adds a new external identity
         #
-        # @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 [Hash] :body  (Required: source_user_id, user)
-        # @option body [String] :source_user_id  (*Required)
-        # @option body [String] :user  (*Required)
+        # @param [String] content_source_id Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [Hash] :body (Required: external_user_id, external_user_properties, permissions)
+        # @option body [string] :external_user_id
+        # @option body [Array<object>] :external_user_properties A list of external user properties, where each property is an object with an attribute_name and attribute_value.
+        # @option body [Array<string>] :permissions A list of user permissions.
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-external-identities-api.html#add-external-identity
@@ -36,9 +37,13 @@ module Elastic
         def create_external_identity(content_source_id, arguments = {})
           raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
 
+          unless arguments[:body]
+            raise ArgumentError,
+                  "Required parameter 'body (external_user_id,external_user_properties,permissions)' missing"
+          end
+
           body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :post,
             "api/ws/v1/sources/#{content_source_id}/external_identities/",

data/lib/elastic/workplace-search/api/current_user.rb

@@ -21,23 +21,21 @@ module Elastic
   module EnterpriseSearch
     module WorkplaceSearch
       module Actions
-        #  - Get the authenticated user
+        # getCurrentUser - Get the authenticated user
         # Get the authenticated user
         #
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [Boolean] :get_token Whether or not to include an access token in the response.
+        # @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-user-api.html#get-current-user-api
         #
         def current_user(arguments = {})
           headers = arguments.delete(:headers) || {}
-
           request(
             :get,
             'api/ws/v1/whoami/',
             arguments,
-            {},
+            nil,
             headers
           )
         end

data/lib/elastic/workplace-search/api/delete_content_source.rb

@@ -24,8 +24,8 @@ module Elastic
         # ContentSources - Deletes a content source by ID
         # Deletes a content source by ID
         #
-        # @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
+        # @param [String] content_source_id Unique ID for a Custom API source, provided upon creation of a Custom API Source (*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-content-sources-api.html#remove-content-source-api
@@ -34,12 +34,11 @@ module Elastic
           raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
 
           headers = arguments.delete(:headers) || {}
-
           request(
             :delete,
             "api/ws/v1/sources/#{content_source_id}/",
             arguments,
-            {},
+            nil,
             headers
           )
         end

data/lib/elastic/workplace-search/api/delete_documents.rb

@@ -24,19 +24,19 @@ module Elastic
         # Documents - Deletes a list of documents from a custom content source
         # Remove documents from a Custom API Source
         #
-        # @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 [Array] :document_ids
+        # @param [String] content_source_id Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [Array<String>] :document_ids *Required*
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-custom-sources-api.html#delete-by-id
         #
         def delete_documents(content_source_id, arguments = {})
           raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
+          raise ArgumentError, "Required parameter 'document_ids' missing" unless arguments[:document_ids]
 
           document_ids = arguments.delete(:document_ids) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :post,
             "api/ws/v1/sources/#{content_source_id}/documents/bulk_destroy/",

data/lib/elastic/workplace-search/api/delete_documents_by_query.rb

@@ -24,8 +24,10 @@ module Elastic
         # Documents - Deletes documents by query in a custom content source
         # Deletes documents by query in a custom content source
         #
-        # @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
+        # @param [String] content_source_id Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [Hash] :body
+        # @option body [Hash] :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-custom-sources-api.html#delete-documents-by-query
@@ -35,7 +37,6 @@ module Elastic
 
           body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :delete,
             "api/ws/v1/sources/#{content_source_id}/documents/",

data/lib/elastic/workplace-search/api/delete_external_identity.rb

@@ -24,26 +24,24 @@ module Elastic
         # ExternalIdentities - Deletes an external identity
         # Deletes an external identity
         #
-        # @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] content_source_id Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [String] :external_user_id Unique identifier of an external user, such as username or email address. (*Required*)
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-external-identities-api.html#remove-external-identity
         #
         def delete_external_identity(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]
+          raise ArgumentError, "Required parameter 'external_user_id' missing" unless arguments[:external_user_id]
 
+          external_user_id = arguments.delete(:external_user_id)
           headers = arguments.delete(:headers) || {}
-
           request(
             :delete,
-            "api/ws/v1/sources/#{content_source_id}/external_identities/#{user}/",
+            "api/ws/v1/sources/#{content_source_id}/external_identities/#{external_user_id}/",
             arguments,
-            {},
+            nil,
             headers
           )
         end

data/lib/elastic/workplace-search/api/delete_synonym_set.rb

@@ -24,7 +24,7 @@ module Elastic
         # Synonyms - Delete a synonym set
         # Delete a synonym set
         #
-        # @param arguments [Hash] endpoint arguments
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [String] :synonym_set_id Synonym Set ID (*Required*)
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
@@ -33,15 +33,13 @@ module Elastic
         def delete_synonym_set(arguments = {})
           raise ArgumentError, "Required parameter 'synonym_set_id' missing" unless arguments[:synonym_set_id]
 
-          synonym_set_id = arguments[:synonym_set_id]
-
+          synonym_set_id = arguments.delete(:synonym_set_id)
           headers = arguments.delete(:headers) || {}
-
           request(
             :delete,
             "api/ws/v1/synonyms/#{synonym_set_id}/",
             arguments,
-            {},
+            nil,
             headers
           )
         end

data/lib/elastic/workplace-search/api/document.rb

@@ -24,8 +24,8 @@ module Elastic
         # Documents - Retrieves a document by ID from the specified content source
         # Retrieves a document by ID from the specified content source
         #
-        # @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
+        # @param [String] content_source_id Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [String] :document_id Unique ID for a content source document. Provided upon or returned at creation. (*Required*)
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
@@ -35,15 +35,13 @@ module Elastic
           raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
           raise ArgumentError, "Required parameter 'document_id' missing" unless arguments[:document_id]
 
-          document_id = arguments[:document_id]
-
+          document_id = arguments.delete(:document_id)
           headers = arguments.delete(:headers) || {}
-
           request(
             :get,
             "api/ws/v1/sources/#{content_source_id}/documents/#{document_id}/",
             arguments,
-            {},
+            nil,
             headers
           )
         end

data/lib/elastic/workplace-search/api/external_identity.rb

@@ -24,26 +24,24 @@ module Elastic
         # ExternalIdentities - Retrieves an external identity
         # Retrieves an external identity
         #
-        # @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] content_source_id Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [String] :external_user_id Unique identifier of an external user, such as username or email address. (*Required*)
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-external-identities-api.html#show-external-identity
         #
         def external_identity(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]
+          raise ArgumentError, "Required parameter 'external_user_id' missing" unless arguments[:external_user_id]
 
+          external_user_id = arguments.delete(:external_user_id)
           headers = arguments.delete(:headers) || {}
-
           request(
             :get,
-            "api/ws/v1/sources/#{content_source_id}/external_identities/#{user}/",
+            "api/ws/v1/sources/#{content_source_id}/external_identities/#{external_user_id}/",
             arguments,
-            {},
+            nil,
             headers
           )
         end

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

@@ -24,9 +24,9 @@ module Elastic
         # Documents - Indexes one or more new documents into a custom content source, or updates one or more existing documents
         # Indexes one or more new documents into a custom content source, or updates one or more existing documents
         #
-        # @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 [Array] :documents (*Required*)
+        # @param [String] content_source_id Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [Array<Hash> { id: [] }, { last_updated: [] }, { _allow_permissions: [] }, { _deny_permissions: [] }] :documents *Required*
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-custom-sources-api.html#index-and-update
@@ -37,7 +37,6 @@ module Elastic
 
           documents = arguments.delete(:documents) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :post,
             "api/ws/v1/sources/#{content_source_id}/documents/bulk_create/",

data/lib/elastic/workplace-search/api/list_content_sources.rb

@@ -24,7 +24,7 @@ module Elastic
         # ContentSources - Retrieves all content sources
         # Retrieves all content sources
         #
-        # @param arguments [Hash] endpoint arguments
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [Integer] :current_page Which page of results to request
         # @option arguments [Integer] :page_size The number of results to return in a page
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
@@ -33,12 +33,11 @@ module Elastic
         #
         def list_content_sources(arguments = {})
           headers = arguments.delete(:headers) || {}
-
           request(
             :get,
             'api/ws/v1/sources/',
             arguments,
-            {},
+            nil,
             headers
           )
         end

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

@@ -24,13 +24,13 @@ module Elastic
         # Documents - Lists documents from a custom content source
         # Lists documents from a custom content source
         #
-        # @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
+        # @param [String] content_source_id Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [Hash] :body
-        # @option body [Object] :page Paging controls for the result set
+        # @option body [Hash] :page Paging controls for the result set
         # @option body :filters
         # @option body :sort
-        # @option body [String] :cursor
+        # @option body [string] :cursor
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-custom-sources-api.html#list-documents
@@ -40,7 +40,6 @@ module Elastic
 
           body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :post,
             "api/ws/v1/sources/#{content_source_id}/documents/",

data/lib/elastic/workplace-search/api/list_external_identities.rb

@@ -24,8 +24,8 @@ module Elastic
         # ExternalIdentities - Retrieves all external identities
         # Retrieves all external identities
         #
-        # @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
+        # @param [String] content_source_id Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [Integer] :current_page Which page of results to request
         # @option arguments [Integer] :page_size The number of results to return in a page
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
@@ -36,12 +36,11 @@ module Elastic
           raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
 
           headers = arguments.delete(:headers) || {}
-
           request(
             :get,
             "api/ws/v1/sources/#{content_source_id}/external_identities/",
             arguments,
-            {},
+            nil,
             headers
           )
         end

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

@@ -24,7 +24,7 @@ module Elastic
         # Synonyms - Retrieves all synonym sets
         # Retrieve a list of synonym sets
         #
-        # @param arguments [Hash] endpoint arguments
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [Hash] :body
         # @option body :page
         # @option body :sort
@@ -36,7 +36,6 @@ module Elastic
         def list_synonym_sets(arguments = {})
           body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :get,
             'api/ws/v1/synonyms/',

data/lib/elastic/workplace-search/api/put_content_source.rb

@@ -24,13 +24,13 @@ module Elastic
         # ContentSources - Update a content source
         # Update a content source
         #
-        # @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 [Hash] :body Definition to update a Workplace Search Content Source (Required: name, is_searchable)
-        # @option body [String] :name The human readable display name for this Content Source. (*Required)
+        # @param [String] content_source_id Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [Hash] :body (Required: name, is_searchable)
+        # @option body [string] :name The human readable display name for this Content Source.
         # @option body :schema The schema that each document in this Content Source will adhere to.
         # @option body :display The display details which governs which fields will be displayed, and in what order, in the search results.
-        # @option body [Boolean] :is_searchable Whether or not this Content Source will be searchable on the search page. (*Required)
+        # @option body [boolean] :is_searchable Whether or not this Content Source will be searchable on the search page.
         # @option body :indexing
         # @option body :facets
         # @option body :automatic_query_refinement
@@ -40,10 +40,10 @@ module Elastic
         #
         def put_content_source(content_source_id, arguments = {})
           raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
+          raise ArgumentError, "Required parameter 'body (name,is_searchable)' missing" unless arguments[:body]
 
           body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :put,
             "api/ws/v1/sources/#{content_source_id}/",

data/lib/elastic/workplace-search/api/put_content_source_icons.rb

@@ -24,21 +24,21 @@ module Elastic
         # ContentSources - Upload content source icons
         # Upload content source icons
         #
-        # @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 [Hash] :body Definition to upload Workplace Search Custom Source icons
-        # @option body [String] :main_icon
-        # @option body [String] :alt_icon
+        # @param [String] content_source_id Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [Hash] :body *Required*
+        # @option body [string] :main_icon
+        # @option body [string] :alt_icon
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-content-sources-api.html#upload-content-source-icon-api
         #
         def put_content_source_icons(content_source_id, arguments = {})
           raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
+          raise ArgumentError, "Required parameter 'body' missing" unless arguments[:body]
 
           body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :put,
             "api/ws/v1/sources/#{content_source_id}/icon/",

data/lib/elastic/workplace-search/api/put_external_identity.rb

@@ -24,27 +24,28 @@ module Elastic
         # ExternalIdentities - Updates an external identity
         # Updates an external identity
         #
-        # @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 [Hash] :body  (Required: source_user_id, user)
-        # @option body [String] :source_user_id  (*Required)
-        # @option body [String] :user  (*Required)
+        # @param [String] content_source_id Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [String] :external_user_id Unique identifier of an external user, such as username or email address. (*Required*)
+        # @option arguments [Hash] :body (Required: external_user_id)
+        # @option body [string] :external_user_id
+        # @option body [["array", "null"]] :external_user_properties A list of external user properties, where each property is an object with an attribute_name and attribute_value.
+        # @option body [["array", "null"]] :permissions A list of user permissions.
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-external-identities-api.html#update-external-identity
         #
         def put_external_identity(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]
+          raise ArgumentError, "Required parameter 'external_user_id' missing" unless arguments[:external_user_id]
+          raise ArgumentError, "Required parameter 'body (external_user_id)' missing" unless arguments[:body]
 
-          user = arguments[:user]
+          external_user_id = arguments.delete(:external_user_id)
           body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :put,
-            "api/ws/v1/sources/#{content_source_id}/external_identities/#{user}/",
+            "api/ws/v1/sources/#{content_source_id}/external_identities/#{external_user_id}/",
             arguments,
             body,
             headers

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

@@ -24,21 +24,21 @@ module Elastic
         # Synonyms - Update a synonym set
         # Update a synonym set
         #
-        # @param arguments [Hash] endpoint arguments
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [String] :synonym_set_id Synonym Set ID (*Required*)
-        # @option arguments [Hash] :body  (Required: synonyms)
-        # @option body [Array] :synonyms A list of terms for this synonym set (*Required)
+        # @option arguments [Hash] :body (Required: synonyms)
+        # @option body [Array<string>] :synonyms A list of terms for this synonym set
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-synonyms-api.html#update-synonym
         #
         def put_synonym_set(arguments = {})
           raise ArgumentError, "Required parameter 'synonym_set_id' missing" unless arguments[:synonym_set_id]
+          raise ArgumentError, "Required parameter 'body (synonyms)' missing" unless arguments[:body]
 
           synonym_set_id = arguments.delete(:synonym_set_id)
           body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :put,
             "api/ws/v1/synonyms/#{synonym_set_id}/",

data/lib/elastic/workplace-search/api/put_triggers_blocklist.rb

@@ -21,23 +21,21 @@ module Elastic
   module EnterpriseSearch
     module WorkplaceSearch
       module Actions
+        # putTriggersBlocklist - Update current triggers blocklist
         # Update current triggers blocklist
         #
-        # @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/workplace-search/current/automatic-query-refinement-blocklist.html
         #
         def put_triggers_blocklist(arguments = {})
-          body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :put,
             'api/ws/v1/automatic_query_refinement/',
             arguments,
-            body,
+            nil,
             headers
           )
         end

data/lib/elastic/workplace-search/api/search.rb

@@ -24,31 +24,31 @@ module Elastic
         # Search - Search across available sources with various query tuning options
         # Issue a Search Query
         #
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [String] :access_token OAuth Access Token (*Required*)
-        # @option arguments [Hash] :body
-        # @option body [String] :query A string or number used to find related documents
-        # @option body [Boolean] :automatic_query_refinement Set to false to not automatically refine the query by keywords
-        # @option body [Object] :page Paging controls for the result set
-        # @option body [Object] :search_fields Restrict the fulltext search to only specific fields
-        # @option body [Object] :result_fields Restrict the result fields for each item to the specified fields
+        # @param [Hash] arguments endpoint arguments
+        # @param [String] access_token OAuth Access Token (*Required*)
+        # @option arguments [Hash] :body *Required*
+        # @option body [string] :query A string or number used to find related documents
+        # @option body [boolean] :automatic_query_refinement Set to false to not automatically refine the query by keywords
+        # @option body [Hash] :page Paging controls for the result set
+        # @option body [Hash] :search_fields Restrict the fulltext search to only specific fields
+        # @option body [Hash] :result_fields Restrict the result fields for each item to the specified fields
         # @option body :filters
         # @option body :sort
-        # @option body [Object] :facets
-        # @option body [Object] :boosts
+        # @option body [Hash] :facets
+        # @option body [Hash] :boosts
         # @option body :source_type Optional parameter to search standard, remote only, or all available sources
-        # @option body [Integer] :timeout Optional timeout in ms for searching remote sources
-        # @option body [Array] :content_sources Optional list of content source ids to only return results from
+        # @option body [integer] :timeout Optional timeout in ms for searching remote sources
+        # @option body [Array<string>] :content_sources Optional list of content source ids to only return results from
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-search-api.html
         #
         def search(arguments = {})
           raise ArgumentError, "Required parameter 'access_token' missing" unless arguments[:access_token]
+          raise ArgumentError, "Required parameter 'body' missing" unless arguments[:body]
 
           body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :post,
             'api/ws/v1/search/',

data/lib/elastic/workplace-search/api/synonym_set.rb

@@ -24,7 +24,7 @@ module Elastic
         # Synonyms - Retrieve a synonym set by ID
         # Retrieve a synonym set by ID
         #
-        # @param arguments [Hash] endpoint arguments
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [String] :synonym_set_id Synonym Set ID (*Required*)
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
@@ -33,15 +33,13 @@ module Elastic
         def synonym_set(arguments = {})
           raise ArgumentError, "Required parameter 'synonym_set_id' missing" unless arguments[:synonym_set_id]
 
-          synonym_set_id = arguments[:synonym_set_id]
-
+          synonym_set_id = arguments.delete(:synonym_set_id)
           headers = arguments.delete(:headers) || {}
-
           request(
             :get,
             "api/ws/v1/synonyms/#{synonym_set_id}/",
             arguments,
-            {},
+            nil,
             headers
           )
         end