elasticsearch-serverless 0.5.0 → 0.7.0

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

@@ -22,42 +22,164 @@ module ElasticsearchServerless
   module API
     module Actions
       # Search a vector tile.
-      # Searches a vector tile for geospatial values.
+      # Search a vector tile for geospatial values.
+      # Before using this API, you should be familiar with the Mapbox vector tile specification.
+      # The API returns results as a binary mapbox vector tile.
+      # Internally, Elasticsearch translates a vector tile search API request into a search containing:
+      # * A +geo_bounding_box+ query on the +<field>+. The query uses the +<zoom>/<x>/<y>+ tile as a bounding box.
+      # * A +geotile_grid+ or +geohex_grid+ aggregation on the +<field>+. The +grid_agg+ parameter determines the aggregation type. The aggregation uses the +<zoom>/<x>/<y>+ tile as a bounding box.
+      # * Optionally, a +geo_bounds+ aggregation on the +<field>+. The search only includes this aggregation if the +exact_bounds+ parameter is +true+.
+      # * If the optional parameter +with_labels+ is +true+, the internal search will include a dynamic runtime field that calls the +getLabelPosition+ function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.
+      # For example, Elasticsearch may translate a vector tile search API request with a +grid_agg+ argument of +geotile+ and an +exact_bounds+ argument of +true+ into the following search
+      # +
+      # GET my-index/_search
+      # {
+      #   "size": 10000,
+      #   "query": {
+      #     "geo_bounding_box": {
+      #       "my-geo-field": {
+      #         "top_left": {
+      #           "lat": -40.979898069620134,
+      #           "lon": -45
+      #         },
+      #         "bottom_right": {
+      #           "lat": -66.51326044311186,
+      #           "lon": 0
+      #         }
+      #       }
+      #     }
+      #   },
+      #   "aggregations": {
+      #     "grid": {
+      #       "geotile_grid": {
+      #         "field": "my-geo-field",
+      #         "precision": 11,
+      #         "size": 65536,
+      #         "bounds": {
+      #           "top_left": {
+      #             "lat": -40.979898069620134,
+      #             "lon": -45
+      #           },
+      #           "bottom_right": {
+      #             "lat": -66.51326044311186,
+      #             "lon": 0
+      #           }
+      #         }
+      #       }
+      #     },
+      #     "bounds": {
+      #       "geo_bounds": {
+      #         "field": "my-geo-field",
+      #         "wrap_longitude": false
+      #       }
+      #     }
+      #   }
+      # }
+      # +
+      # The API returns results as a binary Mapbox vector tile.
+      # Mapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:
+      # * A +hits+ layer containing a feature for each +<field>+ value matching the +geo_bounding_box+ query.
+      # * An +aggs+ layer containing a feature for each cell of the +geotile_grid+ or +geohex_grid+. The layer only contains features for cells with matching data.
+      # * A meta layer containing:
+      #   * A feature containing a bounding box. By default, this is the bounding box of the tile.
+      #   * Value ranges for any sub-aggregations on the +geotile_grid+ or +geohex_grid+.
+      #   * Metadata for the search.
+      # The API only returns features that can display at its zoom level.
+      # For example, if a polygon feature has no area at its zoom level, the API omits it.
+      # The API returns errors as UTF-8 encoded JSON.
+      # IMPORTANT: You can specify several options for this API as either a query parameter or request body parameter.
+      # If you specify both parameters, the query parameter takes precedence.
+      # **Grid precision for geotile**
+      # For a +grid_agg+ of +geotile+, you can use cells in the +aggs+ layer as tiles for lower zoom levels.
+      # +grid_precision+ represents the additional zoom levels available through these cells. The final precision is computed by as follows: +<zoom> + grid_precision+.
+      # For example, if +<zoom>+ is 7 and +grid_precision+ is 8, then the +geotile_grid+ aggregation will use a precision of 15.
+      # The maximum final precision is 29.
+      # The +grid_precision+ also determines the number of cells for the grid as follows: +(2^grid_precision) x (2^grid_precision)+.
+      # For example, a value of 8 divides the tile into a grid of 256 x 256 cells.
+      # The +aggs+ layer only contains features for cells with matching data.
+      # **Grid precision for geohex**
+      # For a +grid_agg+ of +geohex+, Elasticsearch uses +<zoom>+ and +grid_precision+ to calculate a final precision as follows: +<zoom> + grid_precision+.
+      # This precision determines the H3 resolution of the hexagonal cells produced by the +geohex+ aggregation.
+      # The following table maps the H3 resolution for each precision.
+      # For example, if +<zoom>+ is 3 and +grid_precision+ is 3, the precision is 6.
+      # At a precision of 6, hexagonal cells have an H3 resolution of 2.
+      # If +<zoom>+ is 3 and +grid_precision+ is 4, the precision is 7.
+      # At a precision of 7, hexagonal cells have an H3 resolution of 3.
+      # | Precision | Unique tile bins | H3 resolution | Unique hex bins |  Ratio |
+      # | --------- | ---------------- | ------------- | ----------------| ----- |
+      # | 1  | 4                  | 0  | 122             | 30.5           |
+      # | 2  | 16                 | 0  | 122             | 7.625          |
+      # | 3  | 64                 | 1  | 842             | 13.15625       |
+      # | 4  | 256                | 1  | 842             | 3.2890625      |
+      # | 5  | 1024               | 2  | 5882            | 5.744140625    |
+      # | 6  | 4096               | 2  | 5882            | 1.436035156    |
+      # | 7  | 16384              | 3  | 41162           | 2.512329102    |
+      # | 8  | 65536              | 3  | 41162           | 0.6280822754   |
+      # | 9  | 262144             | 4  | 288122          | 1.099098206    |
+      # | 10 | 1048576            | 4  | 288122          | 0.2747745514   |
+      # | 11 | 4194304            | 5  | 2016842         | 0.4808526039   |
+      # | 12 | 16777216           | 6  | 14117882        | 0.8414913416   |
+      # | 13 | 67108864           | 6  | 14117882        | 0.2103728354   |
+      # | 14 | 268435456          | 7  | 98825162        | 0.3681524172   |
+      # | 15 | 1073741824         | 8  | 691776122       | 0.644266719    |
+      # | 16 | 4294967296         | 8  | 691776122       | 0.1610666797   |
+      # | 17 | 17179869184        | 9  | 4842432842      | 0.2818666889   |
+      # | 18 | 68719476736        | 10 | 33897029882     | 0.4932667053   |
+      # | 19 | 274877906944       | 11 | 237279209162    | 0.8632167343   |
+      # | 20 | 1099511627776      | 11 | 237279209162    | 0.2158041836   |
+      # | 21 | 4398046511104      | 12 | 1660954464122   | 0.3776573213   |
+      # | 22 | 17592186044416     | 13 | 11626681248842  | 0.6609003122   |
+      # | 23 | 70368744177664     | 13 | 11626681248842  | 0.165225078    |
+      # | 24 | 281474976710656    | 14 | 81386768741882  | 0.2891438866   |
+      # | 25 | 1125899906842620   | 15 | 569707381193162 | 0.5060018015   |
+      # | 26 | 4503599627370500   | 15 | 569707381193162 | 0.1265004504   |
+      # | 27 | 18014398509482000  | 15 | 569707381193162 | 0.03162511259  |
+      # | 28 | 72057594037927900  | 15 | 569707381193162 | 0.007906278149 |
+      # | 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |
+      # Hexagonal cells don't align perfectly on a vector tile.
+      # Some cells may intersect more than one vector tile.
+      # To compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.
+      # Elasticsearch uses the H3 resolution that is closest to the corresponding geotile density.
       #
       # @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*)
       # @option arguments [Integer] :zoom Zoom level for the vector tile to search (*Required*)
       # @option arguments [Integer] :x X coordinate for the vector tile to search (*Required*)
       # @option arguments [Integer] :y Y coordinate for the vector tile to search (*Required*)
-      # @option arguments [Boolean] :exact_bounds If false, the meta layer’s feature is the bounding box of the tile.
-      #  If true, the meta layer’s feature is a bounding box resulting from a
+      # @option arguments [Boolean] :exact_bounds If +false+, the meta layer's feature is the bounding box of the tile.
+      #  If true, the meta layer's feature is a bounding box resulting from a
       #  geo_bounds aggregation. The aggregation runs on <field> values that intersect
       #  the <zoom>/<x>/<y> tile with wrap_longitude set to false. The resulting
       #  bounding box may be larger than the vector tile.
-      # @option arguments [Integer] :extent Size, in pixels, of a side of the tile. Vector tiles are square with equal sides. Server default: 4096.
+      # @option arguments [Integer] :extent The size, in pixels, of a side of the tile. Vector tiles are square with equal sides. Server default: 4096.
       # @option arguments [String] :grid_agg Aggregation used to create a grid for +field+.
       # @option arguments [Integer] :grid_precision Additional zoom levels available through the aggs layer. For example, if <zoom> is 7
       #  and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results
-      #  don’t include the aggs layer. Server default: 8.
+      #  don't include the aggs layer. Server default: 8.
       # @option arguments [String] :grid_type Determines the geometry type for features in the aggs layer. In the aggs layer,
       #  each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon
       #  of the cells bounding box. If 'point' each feature is a Point that is the centroid
       #  of the cell. Server default: grid.
       # @option arguments [Integer] :size Maximum number of features to return in the hits layer. Accepts 0-10000.
-      #  If 0, results don’t include the hits layer. Server default: 10000.
+      #  If 0, results don't include the hits layer. Server default: 10000.
       # @option arguments [Boolean] :with_labels If +true+, the hits and aggs layers will contain additional point features representing
       #  suggested label positions for the original features.
+      #  - +Point+ and +MultiPoint+ features will have one of the points selected.
+      #  - +Polygon+ and +MultiPolygon+ features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree.
+      #  - +LineString+ features will likewise provide a roughly central point selected from the triangle-tree.
+      #  - The aggregation results will provide one central point for each aggregation bucket.
+      #  All attributes from the original features will also be copied to the new label features.
+      #  In addition, the new features will be distinguishable using the tag +_mvt_label_position+.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-mvt
       #
       def search_mvt(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "search_mvt" }
+        request_opts = { endpoint: arguments[:endpoint] || 'search_mvt' }
 
-        defined_params = [:index, :field, :zoom, :x, :y].inject({}) do |set_variables, variable|
+        defined_params = [:index, :field, :zoom, :x, :y].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/search_template.rb

@@ -21,41 +21,41 @@
 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 (*).
+      # @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