elasticsearch-xpack 7.4.0 → 7.5.0.pre.pre

data/lib/elasticsearch/xpack/api/actions/rollup/get_rollup_index_caps.rb

@@ -7,24 +7,30 @@ module Elasticsearch
     module API
       module Rollup
         module Actions
-
           # TODO: Description
+
           #
-          # @option arguments [String] :index The rollup index or index pattern to obtain rollup capabilities from (*Required*)
+          # @option arguments [String] :index The rollup index or index pattern to obtain rollup capabilities from.
+
           #
           # @see
           #
-          def get_rollup_index_caps(arguments={})
+          def get_rollup_index_caps(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+            arguments = arguments.clone
+
+            _index = arguments.delete(:index)
+
             method = Elasticsearch::API::HTTP_GET
-            path   = "#{arguments[:index]}/_xpack/rollup/data"
+            path   = "#{Elasticsearch::API::Utils.__listify(_index)}/_rollup/data"
             params = {}
-            body   = nil
 
+            body = nil
             perform_request(method, path, params, body).body
           end
-        end
       end
     end
+    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/rollup/params_registry.rb

@@ -8,7 +8,6 @@ module Elasticsearch
       module Rollup
         module Actions
           module ParamsRegistry
-
             extend self
 
             # A Mapping of all the actions to their list of valid params.

data/lib/elasticsearch/xpack/api/actions/rollup/put_job.rb

@@ -7,26 +7,32 @@ module Elasticsearch
     module API
       module Rollup
         module Actions
-
           # TODO: Description
+
           #
-          # @option arguments [String] :id The ID of the job to create (*Required*)
+          # @option arguments [String] :id The ID of the job to create
+
           # @option arguments [Hash] :body The job configuration (*Required*)
           #
           # @see
           #
-          def put_job(arguments={})
-            raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+          def put_job(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+            arguments = arguments.clone
+
+            _id = arguments.delete(:id)
+
             method = Elasticsearch::API::HTTP_PUT
-            path   = "_xpack/rollup/job/#{arguments[:id]}"
+            path   = "_rollup/job/#{Elasticsearch::API::Utils.__listify(_id)}"
             params = {}
-            body   = arguments[:body]
 
+            body = arguments[:body]
             perform_request(method, path, params, body).body
           end
-        end
       end
     end
+    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/rollup/rollup_search.rb

@@ -7,34 +7,54 @@ module Elasticsearch
     module API
       module Rollup
         module Actions
-
           # TODO: Description
+
           #
-          # @option arguments [String] :index The index or index-pattern (containing rollup or regular data) that should be searched (*Required*)
-          # @option arguments [String] :type The doc type inside the index
+          # @option arguments [List] :index The indices or index-pattern(s) (containing rollup or regular data) that should be searched
+          # @option arguments [String] :type The doc type inside the index   *Deprecated*
+          # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
+          # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
+
           # @option arguments [Hash] :body The search request body (*Required*)
           #
+          # *Deprecation notice*:
+          # Specifying types in urls has been deprecated
+          # Deprecated since version 7.0.0
+          #
+          #
           # @see
           #
-          def rollup_search(arguments={})
-            raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          def rollup_search(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+            arguments = arguments.clone
+
+            _index = arguments.delete(:index)
+
+            _type = arguments.delete(:type)
 
             method = Elasticsearch::API::HTTP_GET
-            path   = "#{arguments[:index]}/_rollup_search"
+            path   = if _index && _type
+                       "#{Elasticsearch::API::Utils.__listify(_index)}/#{Elasticsearch::API::Utils.__listify(_type)}/_rollup_search"
+                     else
+                       "#{Elasticsearch::API::Utils.__listify(_index)}/_rollup_search"
+  end
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            body   = arguments[:body]
 
+            body = arguments[:body]
             perform_request(method, path, params, body).body
           end
 
           # Register this action with its valid params when the module is loaded.
           #
-          # @since 7.4.0
-          ParamsRegistry.register(:rollup_search, [ :typed_keys,
-                                                    :rest_total_hits_as_int ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:rollup_search, [
+            :typed_keys,
+            :rest_total_hits_as_int
+          ].freeze)
       end
     end
+    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/rollup/start_job.rb

@@ -7,24 +7,30 @@ module Elasticsearch
     module API
       module Rollup
         module Actions
-
           # TODO: Description
+
           #
-          # @option arguments [String] :id The ID of the job to start (*Required*)
+          # @option arguments [String] :id The ID of the job to start
+
           #
           # @see
           #
-          def start_job(arguments={})
+          def start_job(arguments = {})
             raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+            arguments = arguments.clone
+
+            _id = arguments.delete(:id)
+
             method = Elasticsearch::API::HTTP_POST
-            path   = "_xpack/rollup/job/#{arguments[:id]}/_start"
+            path   = "_rollup/job/#{Elasticsearch::API::Utils.__listify(_id)}/_start"
             params = {}
-            body   = nil
 
+            body = nil
             perform_request(method, path, params, body).body
           end
-        end
       end
     end
+    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/rollup/stop_job.rb

@@ -7,24 +7,40 @@ module Elasticsearch
     module API
       module Rollup
         module Actions
-
           # TODO: Description
+
           #
-          # @option arguments [String] :id The ID of the job to stop (*Required*)
+          # @option arguments [String] :id The ID of the job to stop
+          # @option arguments [Boolean] :wait_for_completion True if the API should block until the job has fully stopped, false if should be executed async. Defaults to false.
+          # @option arguments [Time] :timeout Block for (at maximum) the specified duration while waiting for the job to stop.  Defaults to 30s.
+
           #
           # @see
           #
-          def stop_job(arguments={})
+          def stop_job(arguments = {})
             raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+            arguments = arguments.clone
+
+            _id = arguments.delete(:id)
+
             method = Elasticsearch::API::HTTP_POST
-            path   = "_xpack/rollup/job/#{arguments[:id]}/_stop"
-            params = {}
-            body   = nil
+            path   = "_rollup/job/#{Elasticsearch::API::Utils.__listify(_id)}/_stop"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
+            body = nil
             perform_request(method, path, params, body).body
           end
-        end
+
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 6.2.0
+          ParamsRegistry.register(:stop_job, [
+            :wait_for_completion,
+            :timeout
+          ].freeze)
       end
     end
+    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/authenticate.rb

@@ -7,21 +7,23 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Retrieve details about the currently authenticated user
           #
-          # @see https://www.elastic.co/guide/en/x-pack/current/security-api-authenticate.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html
           #
-          def authenticate(arguments={})
+          def authenticate(arguments = {})
+            arguments = arguments.clone
+
             method = Elasticsearch::API::HTTP_GET
-            path   = "_xpack/security/_authenticate"
+            path   = "_security/_authenticate"
             params = {}
-            body   = nil
 
+            body = nil
             perform_request(method, path, params, body).body
           end
-        end
       end
     end
+    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/change_password.rb

@@ -7,34 +7,44 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Change the password of a user
           #
           # @option arguments [String] :username The username of the user to change the password for
+          # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
+          #   (options: true,false,wait_for)
+
           # @option arguments [Hash] :body the new password for the user (*Required*)
-          # @option arguments [Boolean] :refresh Refresh the index after performing the operation
           #
-          # @see https://www.elastic.co/guide/en/x-pack/current/security-api-change-password.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html
           #
-          def change_password(arguments={})
+          def change_password(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
             arguments = arguments.clone
-            username = arguments.delete(:username)
+
+            _username = arguments.delete(:username)
 
             method = Elasticsearch::API::HTTP_PUT
-            path   = Elasticsearch::API::Utils.__pathify "_xpack/security/user/", username, "/_password"
+            path   = if _username
+                       "_security/user/#{Elasticsearch::API::Utils.__listify(_username)}/_password"
+                     else
+                       "_security/user/_password"
+  end
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            body   = arguments[:body]
 
+            body = arguments[:body]
             perform_request(method, path, params, body).body
           end
 
           # Register this action with its valid params when the module is loaded.
           #
-          # @since 7.4.0
-          ParamsRegistry.register(:change_password, [ :refresh ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:change_password, [
+            :refresh
+          ].freeze)
       end
     end
+    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/clear_cached_realms.rb

@@ -7,33 +7,38 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Clears the internal user caches for specified realms
           #
-          # @option arguments [String] :realms Comma-separated list of realms to clear (*Required*)
-          # @option arguments [String] :usernames Comma-separated list of usernames to clear from the cache
+          # @option arguments [List] :realms Comma-separated list of realms to clear
+          # @option arguments [List] :usernames Comma-separated list of usernames to clear from the cache
+
           #
-          # @see https://www.elastic.co/guide/en/x-pack/current/security-api-clear-cache.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html
           #
-          def clear_cached_realms(arguments={})
+          def clear_cached_realms(arguments = {})
             raise ArgumentError, "Required argument 'realms' missing" unless arguments[:realms]
+
             arguments = arguments.clone
-            realms = arguments.delete(:realms)
+
+            _realms = arguments.delete(:realms)
 
             method = Elasticsearch::API::HTTP_POST
-            path   = Elasticsearch::API::Utils.__pathify "_xpack/security/realm/", Elasticsearch::API::Utils.__listify(realms), "_clear_cache"
+            path   = "_security/realm/#{Elasticsearch::API::Utils.__listify(_realms)}/_clear_cache"
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            body   = nil
 
+            body = nil
             perform_request(method, path, params, body).body
           end
 
           # Register this action with its valid params when the module is loaded.
           #
-          # @since 7.4.0
-          ParamsRegistry.register(:clear_cached_realms, [ :usernames ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:clear_cached_realms, [
+            :usernames
+          ].freeze)
       end
     end
+    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/clear_cached_roles.rb

@@ -7,25 +7,30 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Clears the internal caches for specified roles
           #
-          # @option arguments [String] :name Role name (*Required*)
+          # @option arguments [List] :name Role name
+
           #
-          # @see https://www.elastic.co/guide/en/x-pack/current/security-api-roles.html#security-api-clear-role-cache
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html
           #
-          def clear_cached_roles(arguments={})
+          def clear_cached_roles(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
-            method = Elasticsearch::API::HTTP_PUT
-            path   = "_xpack/security/role/#{arguments[:name]}/_clear_cache"
+            arguments = arguments.clone
+
+            _name = arguments.delete(:name)
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_security/role/#{Elasticsearch::API::Utils.__listify(_name)}/_clear_cache"
             params = {}
-            body   = nil
 
+            body = nil
             perform_request(method, path, params, body).body
           end
-        end
       end
     end
+    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/create_api_key.rb

@@ -7,32 +7,37 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Creates an API key for access without requiring basic authentication.
           #
-          # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make
-          #   this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to
-          #   search, if `false` then do nothing with refreshes.
-          #
-          # @option arguments [Hash] :body The api key request to create an API key. (*Required*)
+          # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
+          #   (options: true,false,wait_for)
+
+          # @option arguments [Hash] :body The api key request to create an API key (*Required*)
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html
           #
-          def create_api_key(arguments={})
+          def create_api_key(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+            arguments = arguments.clone
+
             method = Elasticsearch::API::HTTP_PUT
             path   = "_security/api_key"
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
-            perform_request(method, path, params, arguments[:body]).body
+            body = arguments[:body]
+            perform_request(method, path, params, body).body
           end
 
           # Register this action with its valid params when the module is loaded.
           #
-          # @since 7.4.0
-          ParamsRegistry.register(:create_api_key, [ :refresh ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:create_api_key, [
+            :refresh
+          ].freeze)
       end
     end
+    end
   end
 end