elasticsearch-api 8.17.2 → 9.0.0

data/lib/elasticsearch/api/actions/search_application/render_query.rb

@@ -15,24 +15,28 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module SearchApplication
       module Actions
-        # Renders a query for given search application search parameters
+        # Render a search application query.
+        # Generate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified.
+        # If a parameter used in the search template is not specified in +params+, the parameter's default value will be used.
+        # The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API.
+        # You must have +read+ privileges on the backing alias of the search application.
         # 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] :name The name of the search application to render the query for
+        # @option arguments [String] :name The name of the search application to render teh query for. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body Search parameters, which will override any default search parameters defined in the search application template
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-application-render-query.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-render-query
         #
         def render_query(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'search_application.render_query' }
@@ -52,7 +56,7 @@ module Elasticsearch
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_application/search_application/#{Utils.__listify(_name)}/_render_query"
+          path   = "_application/search_application/#{Utils.listify(_name)}/_render_query"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/search_application/search.rb

@@ -15,25 +15,27 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module SearchApplication
       module Actions
-        # Perform a search against a search application
-        # 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.
+        # Run a search application search.
+        # Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.
+        # Unspecified template parameters are assigned their default values if applicable.
+        # This functionality is in Beta and is subject to change. The design and
+        # code is less mature than official GA features and is being provided
+        # as-is with no warranties. Beta features are not subject to the support
+        # SLA of official GA features.
         #
-        # @option arguments [String] :name The name of the search application to be searched
-        # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
+        # @option arguments [String] :name The name of the search application to be searched. (*Required*)
+        # @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 Search parameters, including template parameters that override defaults
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-application-search.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-search
         #
         def search(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'search_application.search' }
@@ -58,7 +60,7 @@ module Elasticsearch
                      Elasticsearch::API::HTTP_GET
                    end
 
-          path = "_application/search_application/#{Utils.__listify(_name)}/_search"
+          path   = "_application/search_application/#{Utils.listify(_name)}/_search"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/search_mvt.rb

@@ -15,39 +15,170 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Actions
-      # Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile.
-      # 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.
+      # Search a vector tile.
+      # 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 [List] :index Comma-separated list of data streams, indices, or aliases to search
-      # @option arguments [String] :field Field containing geospatial data to return
-      # @option arguments [Integer] :zoom Zoom level for the vector tile to search
-      # @option arguments [Integer] :x X coordinate for the vector tile to search
-      # @option arguments [Integer] :y Y coordinate for the vector tile to search
-      # @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.
-      # @option arguments [Integer] :extent Size, in pixels, of a side of the vector tile.
-      # @option arguments [Integer] :grid_precision Additional zoom levels available through the aggs layer. Accepts 0-8.
-      # @option arguments [String] :grid_type Determines the geometry type for features in the aggs layer. (options: grid, point, centroid)
+      # @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
+      #  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 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.
+      # @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.
-      # @option arguments [Boolean|long] :track_total_hits Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.
-      # @option arguments [Boolean] :with_labels If true, the hits and aggs layers will contain additional point features with suggested label positions for the original features.
+      #  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 Search request body.
+      # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-vector-tile-api.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-mvt
       #
       def search_mvt(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'search_mvt' }
 
-        defined_params = %i[index field zoom x y].each_with_object({}) do |variable, set_variables|
+        defined_params = [:index, :field, :zoom, :x, :y].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?
@@ -61,7 +192,7 @@ module Elasticsearch
         arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
-        body   = arguments.delete(:body)
+        body = arguments.delete(:body)
 
         _index = arguments.delete(:index)
 
@@ -74,7 +205,7 @@ module Elasticsearch
         _y = arguments.delete(:y)
 
         method = Elasticsearch::API::HTTP_POST
-        path   = "#{Utils.__listify(_index)}/_mvt/#{Utils.__listify(_field)}/#{Utils.__listify(_zoom)}/#{Utils.__listify(_x)}/#{Utils.__listify(_y)}"
+        path   = "#{Utils.listify(_index)}/_mvt/#{Utils.listify(_field)}/#{Utils.listify(_zoom)}/#{Utils.listify(_x)}/#{Utils.listify(_y)}"
         params = Utils.process_params(arguments)
 
         Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/search_shards.rb

@@ -15,25 +15,39 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Actions
-      # Returns information about the indices and shards that a search request would be executed against.
+      # Get the search shards.
+      # Get the indices and shards that a search request would be run against.
+      # This information can be useful for working out issues or planning optimizations with routing and shard preferences.
+      # When filtered aliases are used, the filter is returned as part of the +indices+ section.
+      # If the Elasticsearch security features are enabled, you must have the +view_index_metadata+ or +manage+ index privilege for the target data stream, index, or alias.
       #
-      # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
-      # @option arguments [String] :routing Specific routing value
-      # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
-      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
-      # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
-      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
-      # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+      # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to search.
+      #  It supports wildcards (+*+).
+      #  To search all data streams and indices, omit this parameter or use +*+ or +_all+.
+      # @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+.
+      # @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] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
+      # @option arguments [Boolean] :local If +true+, the request retrieves information from the local node only.
+      # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
+      #  If the master node is not available before the timeout expires, the request fails and returns an error.
+      #  IT can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  It is random by default.
+      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-shards.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-shards
       #
       def search_shards(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'search_shards' }
@@ -46,13 +60,13 @@ module Elasticsearch
         arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
-        body   = nil
+        body = nil
 
         _index = arguments.delete(:index)
 
         method = Elasticsearch::API::HTTP_GET
         path   = if _index
-                   "#{Utils.__listify(_index)}/_search_shards"
+                   "#{Utils.listify(_index)}/_search_shards"
                  else
                    '_search_shards'
                  end

data/lib/elasticsearch/api/actions/search_template.rb

@@ -15,32 +15,41 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Actions
-      # Allows to use the Mustache language to pre-render a search definition.
+      # Run a search with a search template.
       #
-      # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
-      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
-      # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
-      # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
-      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
-      # @option arguments [List] :routing A comma-separated list of specific routing values
-      # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
-      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
-      # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
-      # @option arguments [Boolean] :profile Specify whether to profile the query execution
-      # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
-      # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
-      # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
+      # @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 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 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 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+ 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 The search definition template and its params (*Required*)
+      # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-template.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-template
       #
       def search_template(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'search_template' }
@@ -55,13 +64,13 @@ module Elasticsearch
         arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
-        body   = arguments.delete(:body)
+        body = arguments.delete(:body)
 
         _index = arguments.delete(:index)
 
         method = Elasticsearch::API::HTTP_POST
         path   = if _index
-                   "#{Utils.__listify(_index)}/_search/template"
+                   "#{Utils.listify(_index)}/_search/template"
                  else
                    '_search/template'
                  end

data/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb

@@ -15,23 +15,25 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module SearchableSnapshots
       module Actions
-        # Retrieve node-level cache statistics about searchable snapshots.
+        # Get cache statistics.
+        # Get statistics about the shared cache for partially mounted indices.
         # 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 [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
+        # @option arguments [String, Array] :node_id The names of the nodes in the cluster to target.
+        # @option arguments [Time] :master_timeout [TODO]
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/searchable-snapshots-apis.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-cache-stats
         #
         def cache_stats(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'searchable_snapshots.cache_stats' }
@@ -50,11 +52,11 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _node_id
-                     "_searchable_snapshots/#{Utils.__listify(_node_id)}/cache/stats"
+                     "_searchable_snapshots/#{Utils.listify(_node_id)}/cache/stats"
                    else
                      '_searchable_snapshots/cache/stats'
                    end
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb

@@ -15,26 +15,28 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module SearchableSnapshots
       module Actions
-        # Clear the cache of searchable snapshots.
+        # Clear the cache.
+        # Clear indices and data streams from the shared cache for partially mounted indices.
         # 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 [List] :index A comma-separated list of index names
+        # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to clear from the cache.
+        #  It supports wildcards (+*+).
+        # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
+        # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes +_all+ string or when no indices have been specified)
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
-        # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
-        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/searchable-snapshots-apis.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-clear-cache
         #
         def clear_cache(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'searchable_snapshots.clear_cache' }
@@ -47,13 +49,13 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_POST
           path   = if _index
-                     "#{Utils.__listify(_index)}/_searchable_snapshots/cache/clear"
+                     "#{Utils.listify(_index)}/_searchable_snapshots/cache/clear"
                    else
                      '_searchable_snapshots/cache/clear'
                    end