elasticsearch-serverless 0.4.0 → 0.6.0

data/lib/elasticsearch-serverless/api/indices/put_data_lifecycle.rb

@@ -37,7 +37,7 @@ module ElasticsearchServerless
         # @option arguments [Time] :timeout Period to wait for a response.
         #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body request body
+        # @option arguments [Hash] :body lifecycle
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html
         #
@@ -50,6 +50,7 @@ module ElasticsearchServerless
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
           arguments = arguments.clone

data/lib/elasticsearch-serverless/api/inference/delete.rb

@@ -23,10 +23,6 @@ module ElasticsearchServerless
     module Inference
       module Actions
         # Delete an inference endpoint
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
         #
         # @option arguments [String] :task_type The task type
         # @option arguments [String] :inference_id The inference Id (*Required*)

data/lib/elasticsearch-serverless/api/inference/get.rb

@@ -23,10 +23,6 @@ module ElasticsearchServerless
     module Inference
       module Actions
         # Get an inference endpoint
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
         #
         # @option arguments [String] :task_type The task type
         # @option arguments [String] :inference_id The inference Id

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

@@ -23,10 +23,6 @@ module ElasticsearchServerless
     module Inference
       module Actions
         # Perform inference on the service
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
         #
         # @option arguments [String] :task_type The task type
         # @option arguments [String] :inference_id The inference Id (*Required*)

data/lib/elasticsearch-serverless/api/inference/put.rb

@@ -23,10 +23,6 @@ module ElasticsearchServerless
     module Inference
       module Actions
         # Create an inference endpoint
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
         #
         # @option arguments [String] :task_type The task type
         # @option arguments [String] :inference_id The inference Id (*Required*)

data/lib/elasticsearch-serverless/api/machine_learning/infer_trained_model.rb

@@ -0,0 +1,69 @@
+# 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 MachineLearning
+      module Actions
+        # Evaluate a trained model.
+        #
+        # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
+        # @option arguments [Time] :timeout Controls the amount of time to wait for inference results. Server default: 10s.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # *Deprecation notice*:
+        # /_ml/trained_models/{model_id}/deployment/_infer is deprecated. Use /_ml/trained_models/{model_id}/_infer instead
+        # Deprecated since version 8.3.0
+        #
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html
+        #
+        def infer_trained_model(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "ml.infer_trained_model" }
+
+          defined_params = [:model_id].inject({}) do |set_variables, variable|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+            set_variables
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _model_id = arguments.delete(:model_id)
+
+          method = ElasticsearchServerless::API::HTTP_POST
+          path   = "_ml/trained_models/#{Utils.listify(_model_id)}/_infer"
+          params = Utils.process_params(arguments)
+
+          ElasticsearchServerless::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch-serverless/api/machine_learning/put_datafeed.rb

@@ -26,12 +26,12 @@ module ElasticsearchServerless
         # Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.
         # You can associate only one datafeed with each anomaly detection job.
         # The datafeed contains a query that runs at a defined interval (+frequency+).
-        # If you are concerned about delayed data, you can add a delay (+query_delay') at each interval.
+        # If you are concerned about delayed data, you can add a delay (+query_delay+) at each interval.
         # When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
         # at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
         # those credentials are used instead.
         # You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
-        # directly to the+.ml-config+index. Do not give users+write+privileges on the+.ml-config` index.
+        # directly to the +.ml-config+ index. Do not give users +write+ privileges on the +.ml-config+ index.
         #
         # @option arguments [String] :datafeed_id A numerical character string that uniquely identifies the datafeed.
         #  This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.

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

@@ -21,7 +21,10 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Allows to get multiple documents in one request.
+      # Get multiple documents.
+      # Get multiple JSON documents by ID from one or more indices.
+      # If you specify an index in the request URI, you only need to specify the document IDs in the request body.
+      # To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.
       #
       # @option arguments [String] :index Name of the index to retrieve documents from when +ids+ are specified, or when a document in the +docs+ array does not specify an index.
       # @option arguments [Boolean] :force_synthetic_source Should this request force synthetic _source?

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

@@ -21,7 +21,17 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Allows to execute several search operations in one request.
+      # Run multiple searches.
+      # The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.
+      # The structure is as follows:
+      #   header
+      #   body
+      #   header
+      #   body
+      # This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.
+      # IMPORTANT: The final line of data must end with a newline character +\n+.
+      # Each newline character may be preceded by a carriage return +\r+.
+      # When sending requests to this endpoint the +Content-Type+ header should be set to +application/x-ndjson+.
       #
       # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and index aliases to search.
       # @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.

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

@@ -21,7 +21,7 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Runs multiple templated searches with a single request.
+      # Run multiple templated searches.
       #
       # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases to search.
       #  Supports wildcards (+*+).

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

@@ -21,7 +21,11 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Returns multiple termvectors in one request.
+      # Get multiple term vectors.
+      # You can specify existing documents by index and ID or provide artificial documents in the body of the request.
+      # You can specify the index in the request body or request URI.
+      # The response contains a +docs+ array with all the fetched termvectors.
+      # Each element has the structure provided by the termvectors API.
       #
       # @option arguments [String] :index Name of the index that contains the documents.
       # @option arguments [Array<String>] :ids A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body

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

@@ -21,12 +21,15 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # A search request by default executes against the most recent visible data of the target indices,
+      # Open a point in time.
+      # A search request by default runs against the most recent visible data of the target indices,
       # which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
       # state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
       # search requests using the same point in time. For example, if refreshes happen between
       # +search_after+ requests, then the results of those requests might not be consistent as changes happening
       # between searches are only visible to the more recent point in time.
+      # A point in time must be opened explicitly before being used in search requests.
+      # The +keep_alive+ parameter tells Elasticsearch how long it should persist.
       #
       # @option arguments [String, Array] :index A comma-separated list of index names to open point in time; use +_all+ or empty string to perform the operation on all indices (*Required*)
       # @option arguments [Time] :keep_alive Extends the time to live of the corresponding point in time. (*Required*)
@@ -37,6 +40,8 @@ module ElasticsearchServerless
       # @option arguments [String, Array<String>] :expand_wildcards 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+. Server default: open.
+      # @option arguments [Boolean] :allow_partial_search_results If +false+, creating a point in time request when a shard is missing or unavailable will throw an exception.
+      #  If +true+, the point in time will contain all the shards that are available at the time of the request.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #

data/lib/elasticsearch-serverless/api/query_rules/test.rb

@@ -0,0 +1,63 @@
+# 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 QueryRules
+      module Actions
+        # Creates or updates a query ruleset.
+        #
+        # @option arguments [String] :ruleset_id The unique identifier of the query ruleset to be created or updated (*Required*)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/test-query-ruleset.html
+        #
+        def test(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "query_rules.test" }
+
+          defined_params = [:ruleset_id].inject({}) do |set_variables, variable|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+            set_variables
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'ruleset_id' missing" unless arguments[:ruleset_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _ruleset_id = arguments.delete(:ruleset_id)
+
+          method = ElasticsearchServerless::API::HTTP_POST
+          path   = "_query_rules/#{Utils.listify(_ruleset_id)}/_test"
+          params = {}
+
+          ElasticsearchServerless::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -21,7 +21,8 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Enables you to evaluate the quality of ranked search results over a set of typical search queries.
+      # Evaluate ranked search results.
+      # Evaluate the quality of ranked search results over a set of typical search queries.
       #
       # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (+*+) expressions are supported.
       #  To target all data streams and indices in a cluster, omit this parameter or use +_all+ or +*+.

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

@@ -21,7 +21,8 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Renders a search template as a search request body.
+      # Render a search template.
+      # Render a search template as a search request body.
       #
       # @option arguments [String] :id ID of the search template to render.
       #  If no +source+ is specified, this or the +id+ request body parameter is required.

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

@@ -21,7 +21,16 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Allows to retrieve a large numbers of results from a single search request.
+      # Run a scrolling search.
+      # IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the +search_after+ parameter with a point in time (PIT).
+      # The scroll API gets large sets of results from a single scrolling search request.
+      # To get the necessary scroll ID, submit a search API request that includes an argument for the +scroll+ query parameter.
+      # The +scroll+ parameter indicates how long Elasticsearch should retain the search context for the request.
+      # The search response returns a scroll ID in the +_scroll_id+ response body parameter.
+      # You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.
+      # If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.
+      # You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.
+      # IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.
       #
       # @option arguments [String] :scroll_id The scroll ID
       # @option arguments [Time] :scroll Period to retain the search context for scrolling. Server default: 1d.
@@ -39,12 +48,6 @@ module ElasticsearchServerless
       def scroll(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || "scroll" }
 
-        defined_params = [:scroll_id].inject({}) do |set_variables, variable|
-          set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
-        end
-        request_opts[:defined_params] = defined_params unless defined_params.empty?
-
         arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
@@ -58,11 +61,7 @@ module ElasticsearchServerless
                    ElasticsearchServerless::API::HTTP_GET
                  end
 
-        path   = if _scroll_id
-                   "_search/scroll/#{Utils.listify(_scroll_id)}"
-                 else
-                   "_search/scroll"
-                 end
+        path   = "_search/scroll"
         params = Utils.process_params(arguments)
 
         ElasticsearchServerless::API::Response.new(

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

@@ -21,7 +21,8 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Returns search hits that match the query defined in the request.
+      # Run a search.
+      # Get search hits that match the query defined in the request.
       # You can provide search queries using the +q+ query string parameter or the request body.
       # If both are specified, only the query parameter is used.
       #
@@ -60,8 +61,6 @@ module ElasticsearchServerless
       #  This parameter can only be used when the +q+ query string parameter is specified.
       # @option arguments [Integer] :max_concurrent_shard_requests Defines the number of concurrent shard requests per node this search executes concurrently.
       #  This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. Server default: 5.
-      # @option arguments [String] :min_compatible_shard_node The minimum version of the node that can handle the request
-      #  Any handling node with a lower version will fail the request.
       # @option arguments [String] :preference Nodes and shards used for the search.
       #  By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are:
       #  +_only_local+ to run the search only on shards on the local node;

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

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module Actions
       # Search a vector tile.
-      # Searches a vector tile for geospatial values.
+      # Search a vector tile for geospatial values.
       #
       # @option arguments [String, Array] :index Comma-separated list of data streams, indices, or aliases to search (*Required*)
       # @option arguments [String] :field Field containing geospatial data to return (*Required*)

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

@@ -21,7 +21,7 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Runs a search with a search template.
+      # 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 (*).

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

@@ -23,7 +23,7 @@ module ElasticsearchServerless
     module Security
       module Actions
         # Create an API key.
-        # Creates an API key for access without requiring basic authentication.
+        # Create an API key for access without requiring basic authentication.
         # 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.

data/lib/elasticsearch-serverless/api/{indices/delete_data_lifecycle.rb → security/delete_role.rb}

@@ -20,21 +20,19 @@
 #
 module ElasticsearchServerless
   module API
-    module Indices
+    module Security
       module Actions
-        # Delete data stream lifecycles.
-        # Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.
+        # Delete roles.
+        # Delete roles in the native realm.
         #
-        # @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream lifecycle will be deleted; use +*+ to get all data streams (*Required*)
-        # @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open)
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
-        # @option arguments [Time] :timeout Explicit timestamp for the document
+        # @option arguments [String] :name Role 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.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html
         #
-        def delete_data_lifecycle(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "indices.delete_data_lifecycle" }
+        def delete_role(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "security.delete_role" }
 
           defined_params = [:name].inject({}) do |set_variables, variable|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
@@ -52,7 +50,7 @@ module ElasticsearchServerless
           _name = arguments.delete(:name)
 
           method = ElasticsearchServerless::API::HTTP_DELETE
-          path   = "_data_stream/#{Utils.listify(_name)}/_lifecycle"
+          path   = "_security/role/#{Utils.listify(_name)}"
           params = Utils.process_params(arguments)
 
           ElasticsearchServerless::API::Response.new(

data/lib/elasticsearch-serverless/api/{enrich/stats.rb → security/get_builtin_privileges.rb}

@@ -20,17 +20,17 @@
 #
 module ElasticsearchServerless
   module API
-    module Enrich
+    module Security
       module Actions
-        # Get enrich stats.
-        # Returns enrich coordinator statistics and information about enrich policies that are currently executing.
+        # Get builtin privileges.
+        # Get 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/enrich-stats-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html
         #
-        def stats(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "enrich.stats" }
+        def get_builtin_privileges(arguments = {})
+          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   = "_enrich/_stats"
+          path   = "_security/privilege/_builtin"
           params = {}
 
           ElasticsearchServerless::API::Response.new(

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

@@ -0,0 +1,72 @@
+# 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
+        # Get roles.
+        # Get roles in the native realm.
+        #
+        # @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
+        #
+        def get_role(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "security.get_role" }
+
+          defined_params = [:name].inject({}) do |set_variables, variable|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+            set_variables
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _name = arguments.delete(:name)
+
+          method = ElasticsearchServerless::API::HTTP_GET
+          path   = if _name
+                     "_security/role/#{Utils.listify(_name)}"
+                   else
+                     "_security/role"
+                   end
+          params = Utils.process_params(arguments)
+
+          if Array(arguments[:ignore]).include?(404)
+            Utils.rescue_from_not_found {
+              ElasticsearchServerless::API::Response.new(
+                perform_request(method, path, params, body, headers, request_opts)
+              )
+            }
+          else
+            ElasticsearchServerless::API::Response.new(
+              perform_request(method, path, params, body, headers, request_opts)
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -23,7 +23,7 @@ module ElasticsearchServerless
     module Security
       module Actions
         # Check user privileges.
-        # Determines whether the specified user has a specified list of privileges.
+        # Determine whether the specified user has a specified list of privileges.
         #
         # @option arguments [String] :user Username
         # @option arguments [Hash] :headers Custom HTTP headers

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

@@ -23,13 +23,14 @@ module ElasticsearchServerless
     module Security
       module Actions
         # Invalidate API keys.
-        # Invalidates one or more 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.
         # 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, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the +ids+ field.
+        # - 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