elasticsearch-xpack 7.4.0 → 7.5.0.pre.pre

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

@@ -7,28 +7,43 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # @option arguments [String] :application Application name (*Required*)
-          # @option arguments [Boolean] :name Privilege name (*Required*)
           #
-          def delete_privileges(arguments={})
-            raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+          # @option arguments [String] :application Application name
+          # @option arguments [String] :name Privilege 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)
+
+          #
+          # @see TODO
+          #
+          def delete_privileges(arguments = {})
             raise ArgumentError, "Required argument 'application' missing" unless arguments[:application]
+            raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+            arguments = arguments.clone
+
+            _application = arguments.delete(:application)
+
+            _name = arguments.delete(:name)
 
             method = Elasticsearch::API::HTTP_DELETE
-            path   = "_xpack/security/privilege/#{arguments.delete(:application)}/#{arguments[:name]}"
+            path   = "_security/privilege/#{Elasticsearch::API::Utils.__listify(_application)}/#{Elasticsearch::API::Utils.__listify(_name)}"
             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(:delete_privileges, [ :refresh ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:delete_privileges, [
+            :refresh
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,34 +7,39 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Remove a role from the native realm
           #
-          # @option arguments [String] :name Role name (*Required*)
-          # @option arguments [Boolean] :refresh Refresh the index after performing the operation
+          # @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)
+
           #
-          # @see https://www.elastic.co/guide/en/x-pack/current/security-api-roles.html#security-api-delete-role
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html
           #
-          def delete_role(arguments={})
+          def delete_role(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+            arguments = arguments.clone
+
+            _name = arguments.delete(:name)
+
             method = Elasticsearch::API::HTTP_DELETE
-            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   = 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
+            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(:delete_role, [ :refresh ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:delete_role, [
+            :refresh
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,34 +7,39 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Delete a role mapping
           #
-          # @option arguments [String] :name Role-mapping name (*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)
+
           #
-          # @see https://www.elastic.co/guide/en/x-pack/master/security-api-role-mapping.html#security-api-delete-role-mapping
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html
           #
-          def delete_role_mapping(arguments={})
+          def delete_role_mapping(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
             arguments = arguments.clone
-            name = arguments.delete(:name)
+
+            _name = arguments.delete(:name)
 
             method = Elasticsearch::API::HTTP_DELETE
-            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   = 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(:delete_role_mapping, [ :name,
-                                                          :refresh ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:delete_role_mapping, [
+            :refresh
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,37 +7,39 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Remove a user from the native realm
           #
-          # @option arguments [String] :username username (*Required*)
-          # @option arguments [Boolean] :refresh Refresh the index after performing the operation
+          # @option arguments [String] :username username
+          # @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)
+
           #
-          # @see https://www.elastic.co/guide/en/x-pack/current/security-api-users.html#security-api-delete-user
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html
           #
-          def delete_user(arguments={})
+          def delete_user(arguments = {})
+            raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
+
             arguments = arguments.clone
-            username  = arguments.delete(:username)
+
+            _username = arguments.delete(:username)
 
             method = Elasticsearch::API::HTTP_DELETE
-            path   = "_xpack/security/user/#{username}"
+            path   = "_security/user/#{Elasticsearch::API::Utils.__listify(_username)}"
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            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
+            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(:delete_user, [ :username,
-                                                  :refresh ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:delete_user, [
+            :refresh
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,35 +7,39 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Disable a user
           #
           # @option arguments [String] :username The username of the user to disable
-          # @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] :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)
+
           #
-          # @see https://www.elastic.co/guide/en/x-pack/5.4/security-api-users.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html
           #
-          def disable_user(arguments={})
+          def disable_user(arguments = {})
+            raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
+
             arguments = arguments.clone
-            username = arguments.delete(:username)
+
+            _username = arguments.delete(:username)
 
             method = Elasticsearch::API::HTTP_PUT
-            path   = "_xpack/security/user/#{username}/_disable"
+            path   = "_security/user/#{Elasticsearch::API::Utils.__listify(_username)}/_disable"
             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(:disable_user, [ :username,
-                                                   :refresh ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:disable_user, [
+            :refresh
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,35 +7,39 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Enable a user
           #
           # @option arguments [String] :username The username of the user to enable
-          # @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] :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)
+
           #
-          # @see https://www.elastic.co/guide/en/x-pack/5.4/security-api-users.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html
           #
-          def enable_user(arguments={})
+          def enable_user(arguments = {})
+            raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
+
             arguments = arguments.clone
-            username = arguments.delete(:username)
+
+            _username = arguments.delete(:username)
 
             method = Elasticsearch::API::HTTP_PUT
-            path   = "_xpack/security/user/#{username}/_enable"
+            path   = "_security/user/#{Elasticsearch::API::Utils.__listify(_username)}/_enable"
             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(:enable_user, [ :username,
-                                                  :refresh ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:enable_user, [
+            :refresh
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,36 +7,41 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Creates an API key for access without requiring basic authentication.
           #
-          # @option arguments [String] :id API key id of the API key to be retrieved.
-          #
-          # @option arguments [String] :name API key name of the API key to be retrieved.
-          #
-          # @option arguments [String] :username user name of the user who created this API key to be retrieved.
-          #
-          # @option arguments [String] :realm_name realm name of the user who created this API key to be retrieved.
+          # @option arguments [String] :id API key id of the API key to be retrieved
+          # @option arguments [String] :name API key name of the API key to be retrieved
+          # @option arguments [String] :username user name of the user who created this API key to be retrieved
+          # @option arguments [String] :realm_name realm name of the user who created this API key to be retrieved
+          # @option arguments [Boolean] :owner flag to query API keys owned by the currently authenticated user
+
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html
           #
-          def get_api_key(arguments={})
+          def get_api_key(arguments = {})
+            arguments = arguments.clone
+
             method = Elasticsearch::API::HTTP_GET
             path   = "_security/api_key"
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
-            perform_request(method, path, params).body
+            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(:get_api_key, [ :id,
-                                                  :name,
-                                                  :username,
-                                                  :realm_name ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:get_api_key, [
+            :id,
+            :name,
+            :username,
+            :realm_name,
+            :owner
+          ].freeze)
       end
     end
+    end
   end
 end

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

@@ -7,21 +7,23 @@ module Elasticsearch
     module API
       module Security
         module Actions
+          # TODO: Description
 
-          # Get builtin privileges.
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html
           #
-          def get_builtin_privileges(arguments={})
+          def get_builtin_privileges(arguments = {})
+            arguments = arguments.clone
+
             method = Elasticsearch::API::HTTP_GET
             path   = "_security/privilege/_builtin"
             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_privileges.rb

@@ -7,25 +7,37 @@ 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
+          # @option arguments [String] :application Application name
+          # @option arguments [String] :name Privilege 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-privileges.html
           #
-          def get_privileges(arguments={})
+          def get_privileges(arguments = {})
+            arguments = arguments.clone
+
+            _application = arguments.delete(:application)
+
+            _name = arguments.delete(:name)
+
             method = Elasticsearch::API::HTTP_GET
-            path   = Elasticsearch::API::Utils.__pathify "_xpack/security/privilege",
-                                                         arguments[:application],
-                                                         Elasticsearch::API::Utils.__listify(arguments[:name])
+            path   = if _application && _name
+                       "_security/privilege/#{Elasticsearch::API::Utils.__listify(_application)}/#{Elasticsearch::API::Utils.__listify(_name)}"
+                     elsif _application
+                       "_security/privilege/#{Elasticsearch::API::Utils.__listify(_application)}"
+                     else
+                       "_security/privilege"
+  end
             params = {}
-            body   = nil
 
+            body = nil
             perform_request(method, path, params, body).body
           end
-        end
       end
     end
+    end
   end
 end