elasticsearch-xpack 7.4.0 → 7.5.0.pre.pre

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

@@ -7,27 +7,36 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Retrieve one or more roles from the native realm
           #
           # @option arguments [String] :name Role name
+
           #
-          # @see https://www.elastic.co/guide/en/x-pack/current/security-api-roles.html#security-api-get-role
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html
           #
-          def get_role(arguments={})
+          def get_role(arguments = {})
+            arguments = arguments.clone
+
+            _name = arguments.delete(:name)
+
             method = Elasticsearch::API::HTTP_GET
-            path   = Elasticsearch::API::Utils.__pathify "_xpack/security/role", Elasticsearch::API::Utils.__listify(arguments[:name])
+            path   = if _name
+                       "_security/role/#{Elasticsearch::API::Utils.__listify(_name)}"
+                     else
+                       "_security/role"
+  end
             params = {}
-            body   = nil
 
+            body = nil
             if Array(arguments[:ignore]).include?(404)
               Elasticsearch::API::Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
             else
               perform_request(method, path, params, body).body
             end
           end
-        end
       end
     end
+    end
   end
 end

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

@@ -7,23 +7,32 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Retrieve the mapping for a role
           #
           # @option arguments [String] :name Role-Mapping name
+
           #
-          # @see https://www.elastic.co/guide/en/x-pack/master/security-api-role-mapping.html#security-api-get-role-mapping
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html
           #
-          def get_role_mapping(arguments={})
+          def get_role_mapping(arguments = {})
+            arguments = arguments.clone
+
+            _name = arguments.delete(:name)
+
             method = Elasticsearch::API::HTTP_GET
-            path   = "_xpack/security/role_mapping/#{Elasticsearch::API::Utils.__listify(arguments[:name])}"
+            path   = if _name
+                       "_security/role_mapping/#{Elasticsearch::API::Utils.__listify(_name)}"
+                     else
+                       "_security/role_mapping"
+  end
             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/get_token.rb

@@ -7,24 +7,26 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Obtain a token for OAuth 2.0 auhentication
-          #
           # @option arguments [Hash] :body The token request to get (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/x-pack/master/security-api-tokens.html#security-api-get-token
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html
           #
-          def get_token(arguments={})
+          def get_token(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+            arguments = arguments.clone
+
             method = Elasticsearch::API::HTTP_POST
-            path   = "_xpack/security/oauth2/token"
+            path   = "_security/oauth2/token"
             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/security/get_user.rb

@@ -7,27 +7,36 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Retrieve one or more users from the native realm
           #
           # @option arguments [List] :username A comma-separated list of usernames
+
           #
-          # @see https://www.elastic.co/guide/en/x-pack/current/security-api-users.html#security-api-get-user
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html
           #
-          def get_user(arguments={})
+          def get_user(arguments = {})
+            arguments = arguments.clone
+
+            _username = arguments.delete(:username)
+
             method = Elasticsearch::API::HTTP_GET
-            path   = Elasticsearch::API::Utils.__pathify "_xpack/security/user", Elasticsearch::API::Utils.__listify(arguments[:username])
+            path   = if _username
+                       "_security/user/#{Elasticsearch::API::Utils.__listify(_username)}"
+                     else
+                       "_security/user"
+  end
             params = {}
-            body   = nil
 
+            body = nil
             if Array(arguments[:ignore]).include?(404)
               Elasticsearch::API::Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
             else
               perform_request(method, path, params, body).body
             end
           end
-        end
       end
     end
+    end
   end
 end

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

@@ -7,18 +7,23 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Get user privileges
           #
-          def get_user_privileges(arguments={})
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html
+          #
+          def get_user_privileges(arguments = {})
+            arguments = arguments.clone
+
             method = Elasticsearch::API::HTTP_GET
+            path   = "_security/user/_privileges"
             params = {}
-            body   = nil
 
-            perform_request(method, '_xpack/security/user/_privileges', params, body).body
+            body = nil
+            perform_request(method, path, params, body).body
           end
-        end
       end
     end
+    end
   end
 end

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

@@ -7,25 +7,35 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Remove a role from the native realm
           #
           # @option arguments [String] :user Username
-          # @option arguments [String] :body The privileges to test (*Required*)
+
+          # @option arguments [Hash] :body The privileges to test (*Required*)
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html
           #
-          def has_privileges(arguments={})
+          def has_privileges(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
-            method = Elasticsearch::API::HTTP_GET
+            arguments = arguments.clone
+
+            _user = arguments.delete(:user)
 
-            path   = Elasticsearch::API::Utils.__pathify "_xpack/security/user", arguments[:user], "_has_privileges"
+            method = Elasticsearch::API::HTTP_GET
+            path   = if _user
+                       "_security/user/#{Elasticsearch::API::Utils.__listify(_user)}/_has_privileges"
+                     else
+                       "_security/user/_has_privileges"
+  end
+            params = {}
 
-            perform_request(method, path, {}, arguments[:body]).body
+            body = arguments[:body]
+            perform_request(method, path, params, body).body
           end
-        end
       end
     end
+    end
   end
 end

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

@@ -7,24 +7,26 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Creates an API key for access without requiring basic authentication.
-          #
-          # @option arguments [Hash] :body The api key request to invalidate API key(s). (*Required*)
+          # @option arguments [Hash] :body The api key request to invalidate API key(s) (*Required*)
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html
           #
-          def invalidate_api_key(arguments={})
+          def invalidate_api_key(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
+            arguments = arguments.clone
+
             method = Elasticsearch::API::HTTP_DELETE
             path   = "_security/api_key"
             params = {}
 
-            perform_request(method, path, params, arguments[:body]).body
+            body = arguments[:body]
+            perform_request(method, path, params, body).body
           end
-        end
       end
     end
+    end
   end
 end

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

@@ -7,24 +7,26 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Delete a token for OAuth 2.0 auhentication
-          #
           # @option arguments [Hash] :body The token to invalidate (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/x-pack/master/security-api-tokens.html#security-api-invalidate-token
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html
           #
-          def invalidate_token(arguments={})
+          def invalidate_token(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+            arguments = arguments.clone
+
             method = Elasticsearch::API::HTTP_DELETE
-            path   = "_xpack/security/oauth2/token"
+            path   = "_security/oauth2/token"
             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/security/params_registry.rb

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

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

@@ -7,29 +7,37 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Add a privilege
           #
+          # @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 privilege(s) to add (*Required*)
-          # @option arguments [Boolean] :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.
           #
-          def put_privileges(arguments={})
+          # @see TODO
+          #
+          def put_privileges(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+            arguments = arguments.clone
+
             method = Elasticsearch::API::HTTP_PUT
-            path   = "_xpack/security/privilege"
+            path   = "_security/privilege"
             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(:put_privileges, [ :refresh ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:put_privileges, [
+            :refresh
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,32 +7,41 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Update or create a role for the native shield realm
           #
-          # @option arguments [String] :name Role name (*Required*)
+          # @option arguments [String] :name Role name
+          # @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 role to add (*Required*)
-          # @option arguments [Boolean] :refresh Refresh the index after performing the operation
           #
-          # @see https://www.elastic.co/guide/en/x-pack/current/security-api-roles.html#security-api-put-role
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html
           #
-          def put_role(arguments={})
-            raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+          def put_role(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+            arguments = arguments.clone
+
+            _name = arguments.delete(:name)
+
             method = Elasticsearch::API::HTTP_PUT
-            path   = "_xpack/security/role/#{arguments[:name]}"
+            path   = "_security/role/#{Elasticsearch::API::Utils.__listify(_name)}"
             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(:put_role, [ :refresh ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:put_role, [
+            :refresh
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,38 +7,41 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Add a mapping for a role
           #
-          # @option arguments [String] :name Role-mapping name (*Required*)
-          # @option arguments [Hash] :body The role to add (*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 [String] :name Role-mapping name
+          # @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 role mapping to add (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/x-pack/master/security-api-role-mapping.html#security-api-put-role-mapping
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html
           #
-          def put_role_mapping(arguments={})
-            raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+          def put_role_mapping(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
             arguments = arguments.clone
-            name = arguments.delete(:name)
+
+            _name = arguments.delete(:name)
 
             method = Elasticsearch::API::HTTP_PUT
-            path   = "_xpack/security/role_mapping/#{name}"
+            path   = "_security/role_mapping/#{Elasticsearch::API::Utils.__listify(_name)}"
             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(:put_role_mapping, [ :name,
-                                                       :refresh ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:put_role_mapping, [
+            :refresh
+          ].freeze)
       end
     end
+    end
   end
 end