elasticsearch-serverless 0.6.0 → 0.7.0

data/lib/elasticsearch-serverless/api/search_template.rb

@@ -23,39 +23,39 @@ module ElasticsearchServerless
     module Actions
       # Run a search with a search template.
       #
-      # @option arguments [String, Array] :index Comma-separated list of data streams, indices,
-      #  and aliases to search. Supports wildcards (*).
+      # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to search.
+      #  It supports wildcards (+*+).
       # @option arguments [Boolean] :allow_no_indices If +false+, the request returns an error if any wildcard expression, index alias, or +_all+ value targets only missing or closed indices.
       #  This behavior applies even if the request targets other open indices.
       #  For example, a request targeting +foo*,bar*+ returns an error if an index starts with +foo+ but no index starts with +bar+. Server default: true.
       # @option arguments [Boolean] :ccs_minimize_roundtrips If +true+, network round-trips are minimized for cross-cluster search requests.
-      # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
+      # @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
       #  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
       #  Supports comma-separated values, such as +open,hidden+.
       #  Valid values are: +all+, +open+, +closed+, +hidden+, +none+.
       # @option arguments [Boolean] :explain If +true+, the response includes additional details about score computation as part of a hit.
       # @option arguments [Boolean] :ignore_throttled If +true+, specified concrete, expanded, or aliased indices are not included in the response when throttled. Server default: true.
       # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
-      # @option arguments [String] :preference Specifies the node or shard the operation should be performed on.
-      #  Random by default.
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  It is random by default.
       # @option arguments [Boolean] :profile If +true+, the query execution is profiled.
-      # @option arguments [String] :routing Custom value used to route operations to a specific shard.
+      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
       # @option arguments [Time] :scroll Specifies how long a consistent view of the index
       #  should be maintained for scrolled search.
       # @option arguments [String] :search_type The type of the search operation.
-      # @option arguments [Boolean] :rest_total_hits_as_int If true, hits.total are rendered as an integer in the response.
+      # @option arguments [Boolean] :rest_total_hits_as_int If +true+, +hits.total+ is rendered as an integer in the response.
+      #  If +false+, it is rendered as an object.
       # @option arguments [Boolean] :typed_keys If +true+, the response prefixes aggregation and suggester names with their respective types.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-template
       #
       def search_template(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "search_template" }
+        request_opts = { endpoint: arguments[:endpoint] || 'search_template' }
 
-        defined_params = [:index].inject({}) do |set_variables, variable|
+        defined_params = [:index].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -72,7 +72,7 @@ module ElasticsearchServerless
         path   = if _index
                    "#{Utils.listify(_index)}/_search/template"
                  else
-                   "_search/template"
+                   '_search/template'
                  end
         params = Utils.process_params(arguments)
 

data/lib/elasticsearch-serverless/api/security/authenticate.rb

@@ -30,10 +30,10 @@ module ElasticsearchServerless
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-authenticate
         #
         def authenticate(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "security.authenticate" }
+          request_opts = { endpoint: arguments[:endpoint] || 'security.authenticate' }
 
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
@@ -41,7 +41,7 @@ module ElasticsearchServerless
           body = nil
 
           method = ElasticsearchServerless::API::HTTP_GET
-          path   = "_security/_authenticate"
+          path   = '_security/_authenticate'
           params = {}
 
           ElasticsearchServerless::API::Response.new(

data/lib/elasticsearch-serverless/api/security/create_api_key.rb

@@ -24,18 +24,22 @@ module ElasticsearchServerless
       module Actions
         # Create an API key.
         # Create an API key for access without requiring basic authentication.
+        # IMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges.
+        # If you specify privileges, the API returns an error.
         # A successful request returns a JSON structure that contains the API key, its unique id, and its name.
         # If applicable, it also returns expiration information for the API key in milliseconds.
         # NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.
+        # The API keys are created by the Elasticsearch API key service, which is automatically enabled.
+        # To configure or turn off the API key service, refer to API key service setting documentation.
         #
         # @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] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key
         #
         def create_api_key(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "security.create_api_key" }
+          request_opts = { endpoint: arguments[:endpoint] || 'security.create_api_key' }
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
@@ -45,7 +49,7 @@ module ElasticsearchServerless
           body = arguments.delete(:body)
 
           method = ElasticsearchServerless::API::HTTP_PUT
-          path   = "_security/api_key"
+          path   = '_security/api_key'
           params = Utils.process_params(arguments)
 
           ElasticsearchServerless::API::Response.new(

data/lib/elasticsearch-serverless/api/security/delete_role.rb

@@ -24,19 +24,20 @@ module ElasticsearchServerless
       module Actions
         # Delete roles.
         # Delete roles in the native realm.
+        # The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
+        # The delete roles API cannot remove roles that are defined in roles files.
         #
-        # @option arguments [String] :name Role name (*Required*)
+        # @option arguments [String] :name The name of the role. (*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.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-role
         #
         def delete_role(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "security.delete_role" }
+          request_opts = { endpoint: arguments[:endpoint] || 'security.delete_role' }
 
-          defined_params = [:name].inject({}) do |set_variables, variable|
+          defined_params = [:name].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/security/get_api_key.rb

@@ -46,10 +46,10 @@ module ElasticsearchServerless
         # @option arguments [Boolean] :with_profile_uid Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-api-key
         #
         def get_api_key(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "security.get_api_key" }
+          request_opts = { endpoint: arguments[:endpoint] || 'security.get_api_key' }
 
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
@@ -57,7 +57,7 @@ module ElasticsearchServerless
           body = nil
 
           method = ElasticsearchServerless::API::HTTP_GET
-          path   = "_security/api_key"
+          path   = '_security/api_key'
           params = Utils.process_params(arguments)
 
           ElasticsearchServerless::API::Response.new(

data/lib/elasticsearch-serverless/api/security/get_builtin_privileges.rb

@@ -27,10 +27,10 @@ module ElasticsearchServerless
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-builtin-privileges
         #
         def get_builtin_privileges(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "security.get_builtin_privileges" }
+          request_opts = { endpoint: arguments[:endpoint] || 'security.get_builtin_privileges' }
 
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
@@ -38,7 +38,7 @@ module ElasticsearchServerless
           body = nil
 
           method = ElasticsearchServerless::API::HTTP_GET
-          path   = "_security/privilege/_builtin"
+          path   = '_security/privilege/_builtin'
           params = {}
 
           ElasticsearchServerless::API::Response.new(

data/lib/elasticsearch-serverless/api/security/get_role.rb

@@ -24,18 +24,21 @@ module ElasticsearchServerless
       module Actions
         # Get roles.
         # Get roles in the native realm.
+        # The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
+        # The get roles API cannot retrieve roles that are defined in roles files.
         #
-        # @option arguments [String, Array<String>] :name The name of the role. You can specify multiple roles as a comma-separated list. If you do not specify this parameter, the API returns information about all roles.
+        # @option arguments [String, Array<String>] :name The name of the role.
+        #  You can specify multiple roles as a comma-separated list.
+        #  If you do not specify this parameter, the API returns information about all roles.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-role
         #
         def get_role(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "security.get_role" }
+          request_opts = { endpoint: arguments[:endpoint] || 'security.get_role' }
 
-          defined_params = [:name].inject({}) do |set_variables, variable|
+          defined_params = [:name].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -50,16 +53,16 @@ module ElasticsearchServerless
           path   = if _name
                      "_security/role/#{Utils.listify(_name)}"
                    else
-                     "_security/role"
+                     '_security/role'
                    end
           params = Utils.process_params(arguments)
 
           if Array(arguments[:ignore]).include?(404)
-            Utils.rescue_from_not_found {
+            Utils.rescue_from_not_found do
               ElasticsearchServerless::API::Response.new(
                 perform_request(method, path, params, body, headers, request_opts)
               )
-            }
+            end
           else
             ElasticsearchServerless::API::Response.new(
               perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch-serverless/api/security/has_privileges.rb

@@ -24,19 +24,20 @@ module ElasticsearchServerless
       module Actions
         # Check user privileges.
         # Determine whether the specified user has a specified list of privileges.
+        # All users can use this API, but only to determine their own privileges.
+        # To check the privileges of other users, you must use the run as feature.
         #
         # @option arguments [String] :user Username
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-has-privileges
         #
         def has_privileges(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "security.has_privileges" }
+          request_opts = { endpoint: arguments[:endpoint] || 'security.has_privileges' }
 
-          defined_params = [:user].inject({}) do |set_variables, variable|
+          defined_params = [:user].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -53,7 +54,7 @@ module ElasticsearchServerless
           path   = if _user
                      "_security/user/#{Utils.listify(_user)}/_has_privileges"
                    else
-                     "_security/user/_has_privileges"
+                     '_security/user/_has_privileges'
                    end
           params = {}
 

data/lib/elasticsearch-serverless/api/security/invalidate_api_key.rb

@@ -25,20 +25,22 @@ module ElasticsearchServerless
         # Invalidate API keys.
         # This API invalidates API keys created by the create API key or grant API key APIs.
         # Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted.
-        # The +manage_api_key+ privilege allows deleting any API keys.
-        # The +manage_own_api_key+ only allows deleting API keys that are owned by the user.
+        # To use this API, you must have at least the +manage_security+, +manage_api_key+, or +manage_own_api_key+ cluster privileges.
+        # The +manage_security+ privilege allows deleting any API key, including both REST and cross cluster API keys.
+        # The +manage_api_key+ privilege allows deleting any REST API key, but not cross cluster API keys.
+        # The +manage_own_api_key+ only allows deleting REST API keys that are owned by the user.
         # In addition, with the +manage_own_api_key+ privilege, an invalidation request must be issued in one of the three formats:
         # - Set the parameter +owner=true+.
-        # - Or, set both +username+ and +realm_name+ to match the user’s identity.
+        # - Or, set both +username+ and +realm_name+ to match the user's identity.
         # - Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the +ids+ field.
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-invalidate-api-key
         #
         def invalidate_api_key(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "security.invalidate_api_key" }
+          request_opts = { endpoint: arguments[:endpoint] || 'security.invalidate_api_key' }
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
@@ -48,7 +50,7 @@ module ElasticsearchServerless
           body = arguments.delete(:body)
 
           method = ElasticsearchServerless::API::HTTP_DELETE
-          path   = "_security/api_key"
+          path   = '_security/api_key'
           params = {}
 
           ElasticsearchServerless::API::Response.new(

data/lib/elasticsearch-serverless/api/security/put_role.rb

@@ -32,14 +32,13 @@ module ElasticsearchServerless
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role
         #
         def put_role(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "security.put_role" }
+          request_opts = { endpoint: arguments[:endpoint] || 'security.put_role' }
 
-          defined_params = [:name].inject({}) do |set_variables, variable|
+          defined_params = [:name].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/security/query_api_keys.rb

@@ -23,19 +23,25 @@ module ElasticsearchServerless
     module Security
       module Actions
         # Find API keys with a query.
-        # Get a paginated list of API keys and their information. You can optionally filter the results with a query.
+        # Get a paginated list of API keys and their information.
+        # You can optionally filter the results with a query.
+        # To use this API, you must have at least the +manage_own_api_key+ or the +read_security+ cluster privileges.
+        # If you have only the +manage_own_api_key+ privilege, this API returns only the API keys that you own.
+        # If you have the +read_security+, +manage_api_key+, or greater privileges (including +manage_security+), this API returns all API keys regardless of ownership.
         #
         # @option arguments [Boolean] :with_limited_by Return the snapshot of the owner user's role descriptors associated with the API key.
-        #  An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors.
-        # @option arguments [Boolean] :with_profile_uid Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.
+        #  An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors (effectively limited by it).
+        #  An API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has +manage_api_key+ or higher privileges.
+        # @option arguments [Boolean] :with_profile_uid Determines whether to also retrieve the profile UID for the API key owner principal.
+        #  If it exists, the profile UID is returned under the +profile_uid+ response field for each API key.
         # @option arguments [Boolean] :typed_keys Determines whether aggregation names are prefixed by their respective types in the response.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-api-keys
         #
         def query_api_keys(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "security.query_api_keys" }
+          request_opts = { endpoint: arguments[:endpoint] || 'security.query_api_keys' }
 
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
@@ -48,7 +54,7 @@ module ElasticsearchServerless
                      ElasticsearchServerless::API::HTTP_GET
                    end
 
-          path   = "_security/_query/api_key"
+          path   = '_security/_query/api_key'
           params = Utils.process_params(arguments)
 
           ElasticsearchServerless::API::Response.new(

data/lib/elasticsearch-serverless/api/security/query_role.rb

@@ -0,0 +1,61 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch-specification
+#
+module ElasticsearchServerless
+  module API
+    module Security
+      module Actions
+        # Find roles with a query.
+        # Get roles in a paginated manner.
+        # The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
+        # The query roles API does not retrieve roles that are defined in roles files, nor built-in ones.
+        # You can optionally filter the results with a query.
+        # Also, the results can be paginated and sorted.
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-role
+        #
+        def query_role(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'security.query_role' }
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          method = if body
+                     ElasticsearchServerless::API::HTTP_POST
+                   else
+                     ElasticsearchServerless::API::HTTP_GET
+                   end
+
+          path   = '_security/_query/role'
+          params = {}
+
+          ElasticsearchServerless::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch-serverless/api/security/update_api_key.rb

@@ -0,0 +1,74 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch-specification
+#
+module ElasticsearchServerless
+  module API
+    module Security
+      module Actions
+        # Update an API key.
+        # Update attributes of an existing API key.
+        # This API supports updates to an API key's access scope, expiration, and metadata.
+        # To use this API, you must have at least the +manage_own_api_key+ cluster privilege.
+        # Users can only update API keys that they created or that were granted to them.
+        # To update another user’s API key, use the +run_as+ feature to submit a request on behalf of another user.
+        # IMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.
+        # Use this API to update API keys created by the create API key or grant API Key APIs.
+        # If you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.
+        # It's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.
+        # The access scope of an API key is derived from the +role_descriptors+ you specify in the request and a snapshot of the owner user's permissions at the time of the request.
+        # The snapshot of the owner's permissions is updated automatically on every call.
+        # IMPORTANT: If you don't specify +role_descriptors+ in the request, a call to this API might still change the API key's access scope.
+        # This change can occur if the owner user's permissions have changed since the API key was created or last modified.
+        #
+        # @option arguments [String] :id The ID of the API key to update. (*Required*)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-api-key
+        #
+        def update_api_key(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'security.update_api_key' }
+
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _id = arguments.delete(:id)
+
+          method = ElasticsearchServerless::API::HTTP_PUT
+          path   = "_security/api_key/#{Utils.listify(_id)}"
+          params = {}
+
+          ElasticsearchServerless::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch-serverless/api/sql/clear_cursor.rb

@@ -22,15 +22,15 @@ module ElasticsearchServerless
   module API
     module SQL
       module Actions
-        # Clears the SQL cursor
+        # Clear an SQL search cursor.
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-clear-cursor
         #
         def clear_cursor(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "sql.clear_cursor" }
+          request_opts = { endpoint: arguments[:endpoint] || 'sql.clear_cursor' }
 
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
@@ -40,7 +40,7 @@ module ElasticsearchServerless
           body = arguments.delete(:body)
 
           method = ElasticsearchServerless::API::HTTP_POST
-          path   = "_sql/close"
+          path   = '_sql/close'
           params = {}
 
           ElasticsearchServerless::API::Response.new(

data/lib/elasticsearch-serverless/api/sql/delete_async.rb

@@ -22,19 +22,23 @@ module ElasticsearchServerless
   module API
     module SQL
       module Actions
-        # Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.
+        # Delete an async SQL search.
+        # Delete an async SQL search or a stored synchronous SQL search.
+        # If the search is still running, the API cancels it.
+        # If the Elasticsearch security features are enabled, only the following users can use this API to delete a search:
+        # * Users with the +cancel_task+ cluster privilege.
+        # * The user who first submitted the search.
         #
-        # @option arguments [String] :id Identifier for the search. (*Required*)
+        # @option arguments [String] :id The identifier for the search. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-async-sql-search-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-delete-async
         #
         def delete_async(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "sql.delete_async" }
+          request_opts = { endpoint: arguments[:endpoint] || 'sql.delete_async' }
 
-          defined_params = [:id].inject({}) do |set_variables, variable|
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/sql/get_async.rb

@@ -22,26 +22,29 @@ module ElasticsearchServerless
   module API
     module SQL
       module Actions
-        # Returns the current status and available results for an async SQL search or stored synchronous SQL search
+        # Get async SQL search results.
+        # Get the current status and available results for an async SQL search or stored synchronous SQL search.
+        # If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.
         #
-        # @option arguments [String] :id Identifier for the search. (*Required*)
-        # @option arguments [String] :delimiter Separator for CSV results. The API only supports this parameter for CSV responses. Server default: ,.
-        # @option arguments [String] :format Format for the response. You must specify a format using this parameter or the
-        #  Accept HTTP header. If you specify both, the API uses this parameter.
-        # @option arguments [Time] :keep_alive Retention period for the search and its results. Defaults
-        #  to the +keep_alive+ period for the original SQL search.
-        # @option arguments [Time] :wait_for_completion_timeout Period to wait for complete results. Defaults to no timeout,
-        #  meaning the request waits for complete search results.
+        # @option arguments [String] :id The identifier for the search. (*Required*)
+        # @option arguments [String] :delimiter The separator for CSV results.
+        #  The API supports this parameter only for CSV responses. Server default: ,.
+        # @option arguments [String] :format The format for the response.
+        #  You must specify a format using this parameter or the +Accept+ HTTP header.
+        #  If you specify both, the API uses this parameter.
+        # @option arguments [Time] :keep_alive The retention period for the search and its results.
+        #  It defaults to the +keep_alive+ period for the original SQL search.
+        # @option arguments [Time] :wait_for_completion_timeout The period to wait for complete results.
+        #  It defaults to no timeout, meaning the request waits for complete search results.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async
         #
         def get_async(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "sql.get_async" }
+          request_opts = { endpoint: arguments[:endpoint] || 'sql.get_async' }
 
-          defined_params = [:id].inject({}) do |set_variables, variable|
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?