elasticsearch-api 9.0.2 → 9.0.4

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

@@ -26,63 +26,17 @@ module Elasticsearch
       # 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
-      #       }
-      #     }
-      #   }
-      # }
-      # +
+      # * 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.
       # 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 `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+.
+      #   * 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.
@@ -90,20 +44,20 @@ module Elasticsearch
       # 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.
+      # 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)+.
+      # 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.
+      # 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.
+      # 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.
+      # 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.
+      # 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 |
       # | --------- | ---------------- | ------------- | ----------------| ----- |
@@ -140,19 +94,20 @@ module Elasticsearch
       # 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.
+      # Learn how to use the vector tile search API with practical examples in the {https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search Vector tile search examples} guide.
       #
       # @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.
+      # @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 [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.
@@ -162,14 +117,28 @@ module Elasticsearch
       #  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.
-      # @option arguments [Boolean] :with_labels If +true+, the hits and aggs layers will contain additional point features representing
+      # @option arguments [Boolean, Integer] :track_total_hits The number of hits matching the query to count accurately.
+      #  If `true`, the exact number of hits is returned at the cost of some performance.
+      #  If `false`, the response does not include the total number of hits matching the query. 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.
+      #  - `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+.
+      #  In addition, the new features will be distinguishable using the tag `_mvt_label_position`.
+      # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+      #  when they occur.
+      # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+      #  returned by Elasticsearch.
+      # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+      #  For example `"exists_time": "1h"` for humans and
+      #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+      #  readable values will be omitted. This makes sense for responses being consumed
+      #  only by machines.
+      # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+      #  this option for debugging only.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #

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

@@ -24,27 +24,37 @@ module Elasticsearch
       # 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.
+      # 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 [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.
+      #  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+.
+      #  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.
+      #  Supports comma-separated values, such as `open,hidden`. 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.
+      #  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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+      #  when they occur.
+      # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+      #  returned by Elasticsearch.
+      # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+      #  For example `"exists_time": "1h"` for humans and
+      #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+      #  readable values will be omitted. This makes sense for responses being consumed
+      #  only by machines.
+      # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+      #  this option for debugging only.
       # @option arguments [Hash] :headers Custom HTTP headers
       #
       # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-shards

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

@@ -24,28 +24,38 @@ module Elasticsearch
       # Run a search with a search template.
       #
       # @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.
+      #  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.
+      #  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.
+      #  Supports comma-separated values, such as `open,hidden`.
+      # @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 [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 [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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+      #  when they occur.
+      # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+      #  returned by Elasticsearch.
+      # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+      #  For example `"exists_time": "1h"` for humans and
+      #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+      #  readable values will be omitted. This makes sense for responses being consumed
+      #  only by machines.
+      # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+      #  this option for debugging only.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #

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

@@ -31,6 +31,17 @@ module Elasticsearch
         #
         # @option arguments [String, Array] :node_id The names of the nodes in the cluster to target.
         # @option arguments [Time] :master_timeout [TODO]
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-cache-stats

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

@@ -30,10 +30,21 @@ module Elasticsearch
         # support SLA of official GA features.
         #
         # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to clear from the cache.
-        #  It supports wildcards (+*+).
+        #  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] :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] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-clear-cache

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

@@ -31,9 +31,20 @@ module Elasticsearch
         # @option arguments [String] :snapshot The name of the snapshot of the index to mount. (*Required*)
         # @option arguments [Time] :master_timeout The period to wait for the master node.
         #  If the master node is not available before the timeout expires, the request fails and returns an error.
-        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
+        #  To indicate that the request should never timeout, set it to `-1`. Server default: 30s.
         # @option arguments [Boolean] :wait_for_completion If true, the request blocks until the operation is complete.
         # @option arguments [String] :storage The mount option for the searchable snapshot index. Server default: full_copy.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #

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

@@ -26,6 +26,17 @@ module Elasticsearch
         #
         # @option arguments [String, Array] :index A comma-separated list of data streams and indices to retrieve statistics for.
         # @option arguments [String] :level Return stats aggregated at cluster, index or shard level
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-stats

data/lib/elasticsearch/api/actions/security/activate_user_profile.rb

@@ -26,13 +26,24 @@ module Elasticsearch
         # Create or update a user profile on behalf of another user.
         # NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.
         # Individual users and external applications should not call this API directly.
-        # The calling application must have either an +access_token+ or a combination of +username+ and +password+ for the user that the profile document is intended for.
+        # The calling application must have either an `access_token` or a combination of `username` and `password` for the user that the profile document is intended for.
         # Elastic reserves the right to change or remove this feature in future releases without prior notice.
-        # This API creates or updates a profile document for end users with information that is extracted from the user's authentication object including +username+, +full_name,+ +roles+, and the authentication realm.
-        # For example, in the JWT +access_token+ case, the profile user's +username+ is extracted from the JWT token claim pointed to by the +claims.principal+ setting of the JWT realm that authenticated the token.
+        # This API creates or updates a profile document for end users with information that is extracted from the user's authentication object including `username`, `full_name,` `roles`, and the authentication realm.
+        # For example, in the JWT `access_token` case, the profile user's `username` is extracted from the JWT token claim pointed to by the `claims.principal` setting of the JWT realm that authenticated the token.
         # When updating a profile document, the API enables the document if it was disabled.
-        # Any updates do not change existing content for either the +labels+ or +data+ fields.
+        # Any updates do not change existing content for either the `labels` or `data` fields.
         #
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
@@ -50,7 +61,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/profile/_activate'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/authenticate.rb

@@ -28,6 +28,17 @@ module Elasticsearch
         # A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.
         # If the user cannot be authenticated, this API returns a 401 status code.
         #
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-authenticate
@@ -42,7 +53,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = '_security/_authenticate'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/bulk_delete_role.rb

@@ -26,7 +26,18 @@ module Elasticsearch
         # The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
         # The bulk delete roles API cannot delete roles that are defined in roles files.
         #
-        # @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 [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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #

data/lib/elasticsearch/api/actions/security/bulk_put_role.rb

@@ -26,7 +26,18 @@ module Elasticsearch
         # The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
         # The bulk create or update roles API cannot update roles that are defined in roles files.
         #
-        # @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 [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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #

data/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb

@@ -28,11 +28,22 @@ module Elasticsearch
         # This API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates.
         # It is not possible to update expired or invalidated API keys.
         # This API supports updates to API key access scope, metadata and expiration.
-        # The access scope of each API key is derived from the +role_descriptors+ you specify in the request and a snapshot of the owner user's permissions at the time of the request.
+        # The access scope of each API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.
         # The snapshot of the owner's permissions is updated automatically on every call.
-        # IMPORTANT: If you don't specify +role_descriptors+ in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified.
+        # IMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified.
         # A successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update.
         #
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
@@ -50,7 +61,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/api_key/_bulk_update'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/change_password.rb

@@ -27,7 +27,18 @@ module Elasticsearch
         #
         # @option arguments [String] :username The user whose password you want to change. If you do not specify this
         #  parameter, the password is changed for the current user.
-        # @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 [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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #

data/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb

@@ -27,8 +27,19 @@ module Elasticsearch
         # The cache is also automatically cleared on state changes of the security index.
         #
         # @option arguments [String, Array] :ids Comma-separated list of API key IDs to evict from the API key cache.
-        #  To evict all API keys, use +*+.
+        #  To evict all API keys, use `*`.
         #  Does not support other wildcard patterns. (*Required*)
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-clear-api-key-cache
@@ -52,7 +63,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = "_security/api_key/#{Utils.listify(_ids)}/_clear_cache"
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb

@@ -27,8 +27,19 @@ module Elasticsearch
         # The cache is also automatically cleared for applications that have their privileges updated.
         #
         # @option arguments [String] :application A comma-separated list of applications.
-        #  To clear all applications, use an asterism (+*+).
+        #  To clear all applications, use an asterism (`*`).
         #  It does not support other wildcard patterns. (*Required*)
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-clear-cached-privileges
@@ -52,7 +63,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = "_security/privilege/#{Utils.listify(_application)}/_clear_cache"
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)