elastic-enterprise-search 7.17.0 → 8.0.0.pre

data/lib/elastic/enterprise-search/api/stats.rb

@@ -23,7 +23,7 @@ module Elastic
       # Stats - Get information about the resource usage of the application, the state of different internal queues, etc.
       # Get information about the resource usage of the application, the state of different internal queues, etc.
       #
-      # @param arguments [Hash] endpoint arguments
+      # @param [Hash] arguments endpoint arguments
       # @option arguments [Array] :include Comma-separated list of stats to return
       # @option arguments [Hash] :headers optional HTTP headers to send with the request
       #
@@ -31,12 +31,11 @@ module Elastic
       #
       def stats(arguments = {})
         headers = arguments.delete(:headers) || {}
-
         request(
           :get,
           'api/ent/v1/internal/stats/',
           arguments,
-          {},
+          nil,
           headers
         )
       end

data/lib/elastic/enterprise-search/api/version.rb

@@ -23,19 +23,18 @@ module Elastic
       # Version - Get version information for this server
       # Get version information for this server
       #
-      # @param arguments [Hash] endpoint arguments
+      # @param [Hash] arguments endpoint arguments
       # @option arguments [Hash] :headers optional HTTP headers to send with the request
       #
       # @see https://www.elastic.co/guide/en/enterprise-search/current/management-apis.html
       #
       def version(arguments = {})
         headers = arguments.delete(:headers) || {}
-
         request(
           :get,
           'api/ent/v1/internal/version/',
           arguments,
-          {},
+          nil,
           headers
         )
       end

data/lib/elastic/enterprise-search/client.rb

@@ -19,7 +19,7 @@
 
 require 'elastic/enterprise-search/request'
 require 'elastic/enterprise-search/utils'
-require 'elasticsearch-transport'
+require 'elastic-transport'
 
 module Elastic
   module EnterpriseSearch
@@ -58,6 +58,7 @@ module Elastic
       # @option options [String] :proxy url of proxy to use, ex: "http://localhost:8888"
       # @option options [Boolean] :log Use the default logger (disabled by default)
       # @option arguments [Object] :logger An instance of a Logger-compatible object
+      # @option arguments [Symbol] :adapter A specific adapter for Faraday (e.g. `:patron`)
       # @option enable_meta_header [Boolean] :enable_meta_header Enable sending the meta data header to Cloud.
       #                                                          (Default: true)
       def initialize(options = {})
@@ -67,11 +68,12 @@ module Elastic
 
       def transport
         @options[:transport] ||
-          transport_klass.new(
+          Elastic::Transport::Client.new(
             host: host,
             log: log,
             logger: logger,
             request_timeout: overall_timeout,
+            adapter: adapter,
             transport_options: {
               request: { open_timeout: open_timeout }
             },
@@ -103,6 +105,10 @@ module Elastic
         @options[:logger]
       end
 
+      def adapter
+        @options[:adapter]
+      end
+
       def host
         return DEFAULT_HOST unless @options[:host]
 
@@ -110,17 +116,6 @@ module Elastic
 
         @options[:host]
       end
-
-      private
-
-      def transport_klass
-        case Elasticsearch::Transport::VERSION
-        when /7\.1[123]/
-          Elasticsearch::Client
-        else
-          Elasticsearch::Transport::Client
-        end
-      end
     end
   end
 end

data/lib/elastic/enterprise-search/request.rb

@@ -19,6 +19,7 @@
 
 require 'net/https'
 require 'json'
+require 'elastic/api/response'
 require 'elastic/enterprise-search/exceptions'
 require 'base64'
 
@@ -53,8 +54,9 @@ module Elastic
                   else
                     headers.merge(meta_headers)
                   end
-
-        @transport.perform_request(method.to_s.upcase, path, params, body, headers)
+        Elastic::API::Response.new(
+          @transport.perform_request(method.to_s.upcase, path, params, body, headers)
+        )
       end
 
       def setup_authentication_header
@@ -84,7 +86,7 @@ module Elastic
           meta << "#{RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase} " \
                   "#{RbConfig::CONFIG['target_cpu']}"
         end
-        meta << "elasticsearch-transport: #{Elasticsearch::Transport::VERSION}"
+        meta << "elastic-transport: #{Elastic::Transport::VERSION}"
         "#{ua} (#{meta.join('; ')})"
       end
 

data/lib/elastic/enterprise-search/version.rb

@@ -19,6 +19,6 @@
 
 module Elastic
   module EnterpriseSearch
-    VERSION = '7.17.0'
+    VERSION = '8.0.0.pre'
   end
 end

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

@@ -24,8 +24,8 @@ module Elastic
         # ContentSources - Retrieves a content source's automatic query refinement details
         # Retrieves a content source's automatic query refinement details
         #
-        # @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#get-automatic-query-refinement-details-api
@@ -34,12 +34,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}/automatic_query_refinement/",
             arguments,
-            {},
+            nil,
             headers
           )
         end

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

@@ -24,21 +24,20 @@ module Elastic
         # SyncJobs - Issue commands to a Content Source's sync jobs
         # Control a content source's sync jobs
         #
-        # @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 Params to command a Workplace Search Content Source's sync jobs (Required: command)
+        # @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] :job_type The type of sync job to consider
-        # @option body :command  (*Required)
+        # @option arguments [Any of: <Hash> - Command to start a synchronisation job for Content Source (force_interrupt<boolean>, command<string>) or <Hash> - Command to interrupt a synchronisation job for Content Source (command<string>)] :body *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-sync-jobs-api.html#command-sync-jobs-api
         #
         def command_sync_jobs(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(
             :post,
             "api/ws/v1/sources/#{content_source_id}/sync/jobs/",

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

@@ -24,8 +24,8 @@ module Elastic
         # ContentSources - Retrieves a content source by ID
         # Retrieves 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#get-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(
             :get,
             "api/ws/v1/sources/#{content_source_id}/",
             arguments,
-            {},
+            nil,
             headers
           )
         end

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

@@ -24,17 +24,17 @@ module Elastic
         # Analytics - Capture click and feedback analytic events
         # Capture Analytic events for click and feedback
         #
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [String] :access_token OAuth Access Token (*Required*)
-        # @option arguments [Hash] :body Workplace Search analytics event (Required: type, query_id, page, content_source_id, document_id, rank)
-        # @option body [String] :type  (*Required)
-        # @option body [String] :query_id query identifier for the event (*Required)
-        # @option body [Integer] :page page number of the document in the query result set (*Required)
-        # @option body [String] :content_source_id content source identifier for the event document (*Required)
-        # @option body [String] :document_id document identifier for the event (*Required)
-        # @option body [Integer] :rank rank of the document in the overall result set (*Required)
-        # @option body [String] :event the target identifier for a click event
-        # @option body [Integer] :score the feedback score, constrained to the values -1 or 1
+        # @param [Hash] arguments endpoint arguments
+        # @param [String] access_token OAuth Access Token (*Required*)
+        # @option arguments [Hash] :body (Required: type, query_id, page, content_source_id, document_id, rank)
+        # @option body [string] :type
+        # @option body [string] :query_id query identifier for the event
+        # @option body [integer] :page page number of the document in the query result set
+        # @option body [string] :content_source_id content source identifier for the event document
+        # @option body [string] :document_id document identifier for the event
+        # @option body [integer] :rank rank of the document in the overall result set
+        # @option body [string] :event the target identifier for a click event
+        # @option body [integer] :score the feedback score, constrained to the values -1 or 1
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-analytics-api.html
@@ -42,9 +42,13 @@ module Elastic
         def create_analytics_event(arguments = {})
           raise ArgumentError, "Required parameter 'access_token' missing" unless arguments[:access_token]
 
+          unless arguments[:body]
+            raise ArgumentError,
+                  "Required parameter 'body (type,query_id,page,content_source_id,document_id,rank)' missing"
+          end
+
           body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :post,
             'api/ws/v1/analytics/event/',

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

@@ -24,8 +24,8 @@ module Elastic
         # Synonyms - Create a batch of synonym sets
         # Create batched synonym sets
         #
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [Hash] :body
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [Hash] :body *Required*
         # @option body :synonyms
         # @option body :synonym_sets
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
@@ -33,9 +33,10 @@ module Elastic
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-synonyms-api.html#create-synonyms
         #
         def create_batch_synonym_sets(arguments = {})
+          raise ArgumentError, "Required parameter 'body' missing" unless arguments[:body]
+
           body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :post,
             'api/ws/v1/synonyms/',

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