elasticsearch-xpack 7.6.0 → 7.7.0.pre

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

@@ -7,21 +7,23 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Removes application privileges.
           #
           # @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)
 
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see TODO
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html
           #
           def delete_privileges(arguments = {})
             raise ArgumentError, "Required argument 'application' missing" unless arguments[:application]
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _application = arguments.delete(:application)
@@ -33,7 +35,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -7,19 +7,21 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Removes roles in the native realm.
           #
           # @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] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html
           #
           def delete_role(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _name = arguments.delete(:name)
@@ -29,7 +31,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -7,19 +7,21 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Removes role mappings.
           #
           # @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] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html
           #
           def delete_role_mapping(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _name = arguments.delete(:name)
@@ -29,7 +31,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -7,19 +7,21 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Deletes users from the native realm.
           #
           # @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)
 
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html
           #
           def delete_user(arguments = {})
             raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _username = arguments.delete(:username)
@@ -29,7 +31,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -7,19 +7,21 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Disables users in the native realm.
           #
           # @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 [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html
           #
           def disable_user(arguments = {})
             raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _username = arguments.delete(:username)
@@ -29,7 +31,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -7,19 +7,21 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Enables users in the native realm.
           #
           # @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 [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html
           #
           def enable_user(arguments = {})
             raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _username = arguments.delete(:username)
@@ -29,7 +31,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -7,19 +7,20 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Retrieves information for one or more API keys.
           #
           # @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
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html
           #
           def get_api_key(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_GET
@@ -27,7 +28,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -7,12 +7,15 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
+          #
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html
           #
           def get_builtin_privileges(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_GET
@@ -20,7 +23,7 @@ module Elasticsearch
             params = {}
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

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

@@ -7,16 +7,17 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Retrieves application privileges.
           #
           # @option arguments [String] :application Application name
           # @option arguments [String] :name Privilege name
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html
           #
           def get_privileges(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _application = arguments.delete(:application)
@@ -30,11 +31,11 @@ module Elasticsearch
                        "_security/privilege/#{Elasticsearch::API::Utils.__listify(_application)}"
                      else
                        "_security/privilege"
-  end
+            end
             params = {}
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

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

@@ -7,15 +7,16 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Retrieves roles in the native realm.
           #
           # @option arguments [String] :name Role name
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html
           #
           def get_role(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _name = arguments.delete(:name)
@@ -25,14 +26,14 @@ module Elasticsearch
                        "_security/role/#{Elasticsearch::API::Utils.__listify(_name)}"
                      else
                        "_security/role"
-  end
+            end
             params = {}
 
             body = nil
             if Array(arguments[:ignore]).include?(404)
-              Elasticsearch::API::Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
+              Elasticsearch::API::Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
             else
-              perform_request(method, path, params, body).body
+              perform_request(method, path, params, body, headers).body
             end
           end
       end

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

@@ -7,15 +7,16 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Retrieves role mappings.
           #
           # @option arguments [String] :name Role-Mapping name
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html
           #
           def get_role_mapping(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _name = arguments.delete(:name)
@@ -25,11 +26,11 @@ module Elasticsearch
                        "_security/role_mapping/#{Elasticsearch::API::Utils.__listify(_name)}"
                      else
                        "_security/role_mapping"
-  end
+            end
             params = {}
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

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

@@ -7,8 +7,9 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Creates a bearer token for access without requiring basic authentication.
+          #
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The token request to get (*Required*)
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html
@@ -16,6 +17,8 @@ module Elasticsearch
           def get_token(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_POST
@@ -23,7 +26,7 @@ module Elasticsearch
             params = {}
 
             body = arguments[:body]
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

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

@@ -7,15 +7,16 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Retrieves information about users in the native realm and built-in users.
           #
           # @option arguments [List] :username A comma-separated list of usernames
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html
           #
           def get_user(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _username = arguments.delete(:username)
@@ -25,14 +26,14 @@ module Elasticsearch
                        "_security/user/#{Elasticsearch::API::Utils.__listify(_username)}"
                      else
                        "_security/user"
-  end
+            end
             params = {}
 
             body = nil
             if Array(arguments[:ignore]).include?(404)
-              Elasticsearch::API::Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
+              Elasticsearch::API::Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
             else
-              perform_request(method, path, params, body).body
+              perform_request(method, path, params, body, headers).body
             end
           end
       end

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

@@ -7,12 +7,15 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Retrieves application privileges.
+          #
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html
           #
           def get_user_privileges(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_GET
@@ -20,7 +23,7 @@ module Elasticsearch
             params = {}
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end