elasticsearch-api 9.1.1 → 9.1.3

data/lib/elasticsearch/api/actions/cat/segments.rb

@@ -30,7 +30,6 @@ module Elasticsearch
         # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases used to limit the request.
         #  Supports wildcards (`*`).
         #  To target all data streams and indices, omit this parameter or use `*` or `_all`.
-        # @option arguments [String] :bytes The unit used to display byte values.
         # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display.
         #  It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l.
         # @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
@@ -41,11 +40,30 @@ module Elasticsearch
         #  from the cluster state of the master node. In both cases the coordinating
         #  node will send requests for further information to each selected node.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
+        # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard expressions 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. Server default: open.
+        # @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] :ignore_throttled If true, concrete, expanded or aliased indices are ignored when frozen.
+        # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response.
+        # @option arguments [Boolean] :allow_closed If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour
+        #  of throwing an exception if index pattern matches closed indices
         # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
         #  `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
         # @option arguments [Boolean] :help When set to `true` will output available columns. This option
         #  can't be combined with any other query string option.
         # @option arguments [Boolean] :v When set to `true` will enable verbose output.
+        # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
+        #  Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
+        #  If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
+        #  If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
+        #  Values that are not an exact multiple of the chosen unit are rounded down.
+        # @option arguments [String] :time Sets the units for columns that contain a time duration.
+        #  If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
+        #  If given, time duration values are rendered as an integer with no suffix.
+        #  Values that are not an exact multiple of the chosen unit are rounded down.
         # @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

data/lib/elasticsearch/api/actions/cat/shards.rb

@@ -30,18 +30,25 @@ module Elasticsearch
         # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases used to limit the request.
         #  Supports wildcards (`*`).
         #  To target all data streams and indices, omit this parameter or use `*` or `_all`.
-        # @option arguments [String] :bytes The unit used to display byte values.
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
         # @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
         #  Sorting defaults to ascending and can be changed by setting `:asc`
         #  or `:desc` as a suffix to the column name.
         # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
-        # @option arguments [String] :time The unit used to display time values.
         # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
         #  `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
         # @option arguments [Boolean] :help When set to `true` will output available columns. This option
         #  can't be combined with any other query string option.
         # @option arguments [Boolean] :v When set to `true` will enable verbose output.
+        # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
+        #  Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
+        #  If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
+        #  If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
+        #  Values that are not an exact multiple of the chosen unit are rounded down.
+        # @option arguments [String] :time Sets the units for columns that contain a time duration.
+        #  If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
+        #  If given, time duration values are rendered as an integer with no suffix.
+        #  Values that are not an exact multiple of the chosen unit are rounded down.
         # @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

data/lib/elasticsearch/api/actions/cat/snapshots.rb

@@ -38,12 +38,20 @@ module Elasticsearch
         #  Sorting defaults to ascending and can be changed by setting `:asc`
         #  or `:desc` as a suffix to the column name.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
-        # @option arguments [String] :time Unit used to display time values.
         # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
         #  `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
         # @option arguments [Boolean] :help When set to `true` will output available columns. This option
         #  can't be combined with any other query string option.
         # @option arguments [Boolean] :v When set to `true` will enable verbose output.
+        # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
+        #  Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
+        #  If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
+        #  If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
+        #  Values that are not an exact multiple of the chosen unit are rounded down.
+        # @option arguments [String] :time Sets the units for columns that contain a time duration.
+        #  If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
+        #  If given, time duration values are rendered as an integer with no suffix.
+        #  Values that are not an exact multiple of the chosen unit are rounded down.
         # @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

data/lib/elasticsearch/api/actions/cat/tasks.rb

@@ -34,11 +34,10 @@ module Elasticsearch
         # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
         # @option arguments [Array<String>] :nodes Unique node identifiers, which are used to limit the response.
         # @option arguments [String] :parent_task_id The parent task identifier, which is used to limit the response.
-        # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
+        # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting `:asc`
         #  or `:desc` as a suffix to the column name.
-        # @option arguments [String] :time Unit used to display time values.
         # @option arguments [Time] :timeout Period to wait for a response.
         #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the task has completed.
@@ -47,6 +46,15 @@ module Elasticsearch
         # @option arguments [Boolean] :help When set to `true` will output available columns. This option
         #  can't be combined with any other query string option.
         # @option arguments [Boolean] :v When set to `true` will enable verbose output.
+        # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
+        #  Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
+        #  If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
+        #  If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
+        #  Values that are not an exact multiple of the chosen unit are rounded down.
+        # @option arguments [String] :time Sets the units for columns that contain a time duration.
+        #  If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
+        #  If given, time duration values are rendered as an integer with no suffix.
+        #  Values that are not an exact multiple of the chosen unit are rounded down.
         # @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

data/lib/elasticsearch/api/actions/cat/templates.rb

@@ -29,7 +29,7 @@ module Elasticsearch
         #
         # @option arguments [String] :name The name of the template to return.
         #  Accepts wildcard expressions. If omitted, all templates are returned.
-        # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
+        # @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting `:asc`
         #  or `:desc` as a suffix to the column name.
@@ -43,6 +43,15 @@ module Elasticsearch
         # @option arguments [Boolean] :help When set to `true` will output available columns. This option
         #  can't be combined with any other query string option.
         # @option arguments [Boolean] :v When set to `true` will enable verbose output.
+        # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
+        #  Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
+        #  If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
+        #  If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
+        #  Values that are not an exact multiple of the chosen unit are rounded down.
+        # @option arguments [String] :time Sets the units for columns that contain a time duration.
+        #  If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
+        #  If given, time duration values are rendered as an integer with no suffix.
+        #  Values that are not an exact multiple of the chosen unit are rounded down.
         # @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

data/lib/elasticsearch/api/actions/cat/thread_pool.rb

@@ -33,7 +33,6 @@ module Elasticsearch
         # @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
         #  Sorting defaults to ascending and can be changed by setting `:asc`
         #  or `:desc` as a suffix to the column name.
-        # @option arguments [String] :time The unit used to display time values.
         # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the
         #  local cluster state. If `false` the list of selected nodes are computed
         #  from the cluster state of the master node. In both cases the coordinating
@@ -44,6 +43,15 @@ module Elasticsearch
         # @option arguments [Boolean] :help When set to `true` will output available columns. This option
         #  can't be combined with any other query string option.
         # @option arguments [Boolean] :v When set to `true` will enable verbose output.
+        # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
+        #  Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
+        #  If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
+        #  If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
+        #  Values that are not an exact multiple of the chosen unit are rounded down.
+        # @option arguments [String] :time Sets the units for columns that contain a time duration.
+        #  If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
+        #  If given, time duration values are rendered as an integer with no suffix.
+        #  Values that are not an exact multiple of the chosen unit are rounded down.
         # @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

data/lib/elasticsearch/api/actions/cat/transforms.rb

@@ -36,13 +36,21 @@ module Elasticsearch
         # @option arguments [Integer] :from Skips the specified number of transforms. Server default: 0.
         # @option arguments [String, Array<String>] :h Comma-separated list of column names to display. Server default: changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state.
         # @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the response.
-        # @option arguments [String] :time The unit used to display time values.
         # @option arguments [Integer] :size The maximum number of transforms to obtain. Server default: 100.
         # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
         #  `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
         # @option arguments [Boolean] :help When set to `true` will output available columns. This option
         #  can't be combined with any other query string option.
         # @option arguments [Boolean] :v When set to `true` will enable verbose output.
+        # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
+        #  Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
+        #  If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
+        #  If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
+        #  Values that are not an exact multiple of the chosen unit are rounded down.
+        # @option arguments [String] :time Sets the units for columns that contain a time duration.
+        #  If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
+        #  If given, time duration values are rendered as an integer with no suffix.
+        #  Values that are not an exact multiple of the chosen unit are rounded down.
         # @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

data/lib/elasticsearch/api/actions/cluster/get_settings.rb

@@ -26,7 +26,12 @@ module Elasticsearch
         # By default, it returns only settings that have been explicitly defined.
         #
         # @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format.
-        # @option arguments [Boolean] :include_defaults If `true`, returns default cluster settings from the local node.
+        # @option arguments [Boolean] :include_defaults If `true`, also returns default values for all other cluster settings, reflecting the values
+        #  in the `elasticsearch.yml` file of one of the nodes in the cluster. If the nodes in your
+        #  cluster do not all have the same values in their `elasticsearch.yml` config files then the
+        #  values returned by this API may vary from invocation to invocation and may not reflect the
+        #  values that Elasticsearch uses in all situations. Use the `GET _nodes/settings` API to
+        #  fetch the settings for each individual node in your cluster.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
         #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Time] :timeout Period to wait for a response.

data/lib/elasticsearch/api/actions/connector/delete.rb

@@ -33,7 +33,7 @@ module Elasticsearch
         # SLA of official GA features.
         #
         # @option arguments [String] :connector_id The unique identifier of the connector to be deleted (*Required*)
-        # @option arguments [Boolean] :delete_sync_jobs A flag indicating if associated sync jobs should be also removed. Defaults to false.
+        # @option arguments [Boolean] :delete_sync_jobs A flag indicating if associated sync jobs should be also removed.
         # @option arguments [Boolean] :hard A flag indicating if the connector should be hard deleted.
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
         #  when they occur.

data/lib/elasticsearch/api/actions/connector/list.rb

@@ -29,8 +29,8 @@ module Elasticsearch
         # as-is with no warranties. Beta features are not subject to the support
         # SLA of official GA features.
         #
-        # @option arguments [Integer] :from Starting offset (default: 0)
-        # @option arguments [Integer] :size Specifies a max number of results to get
+        # @option arguments [Integer] :from Starting offset Server default: 0.
+        # @option arguments [Integer] :size Specifies a max number of results to get Server default: 100.
         # @option arguments [String, Array] :index_name A comma-separated list of connector index names to fetch connector documents for
         # @option arguments [String, Array<String>] :connector_name A comma-separated list of connector names to fetch connector documents for
         # @option arguments [String, Array<String>] :service_type A comma-separated list of connector service types to fetch connector documents for

data/lib/elasticsearch/api/actions/connector/sync_job_list.rb

@@ -29,8 +29,8 @@ module Elasticsearch
         # as-is with no warranties. Beta features are not subject to the support
         # SLA of official GA features.
         #
-        # @option arguments [Integer] :from Starting offset (default: 0)
-        # @option arguments [Integer] :size Specifies a max number of results to get
+        # @option arguments [Integer] :from Starting offset Server default: 0.
+        # @option arguments [Integer] :size Specifies a max number of results to get Server default: 100.
         # @option arguments [String] :status A sync job status to fetch connector sync jobs for
         # @option arguments [String] :connector_id A connector id to fetch connector sync jobs for
         # @option arguments [String, Array<String>] :job_type A comma-separated list of job types to fetch the sync jobs for

data/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb

@@ -31,7 +31,7 @@ module Elasticsearch
         # @option arguments [Integer, String] :wait_for_active_shards Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be
         #  active.
         #  A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the
-        #  remote Lucene segment files to the follower index.
+        #  remote Lucene segment files to the follower index. Server default: 0.
         # @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

data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb

@@ -28,7 +28,7 @@ module Elasticsearch
         #
         # @option arguments [String] :index_uuid The UUID of the index to delete. Use the get dangling indices API to find the UUID. (*Required*)
         # @option arguments [Boolean] :accept_data_loss This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index. (*Required*)
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
         #  when they occur.

data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb

@@ -29,7 +29,7 @@ module Elasticsearch
         # @option arguments [String] :index_uuid The UUID of the index to import. Use the get dangling indices API to locate the UUID. (*Required*)
         # @option arguments [Boolean] :accept_data_loss This parameter must be set to true to import a dangling index.
         #  Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster. (*Required*)
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
         #  when they occur.

data/lib/elasticsearch/api/actions/eql/get.rb

@@ -27,7 +27,7 @@ module Elasticsearch
         #
         # @option arguments [String] :id Identifier for the search. (*Required*)
         # @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster.
-        #  Defaults to the keep_alive value set by the search’s EQL search API request.
+        #  Defaults to the keep_alive value set by the search’s EQL search API request. Server default: 5d.
         # @option arguments [Time] :wait_for_completion_timeout Timeout duration to wait for the request to finish.
         #  Defaults to no timeout, meaning the request waits for complete search results.
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

data/lib/elasticsearch/api/actions/esql/async_query.rb

@@ -29,7 +29,7 @@ module Elasticsearch
         # @option arguments [Boolean] :allow_partial_results If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.
         #  If `false`, the query will fail if there are any failures.To override the default behavior, you can set the `esql.query.allow_partial_results` cluster setting to `false`. Server default: true.
         # @option arguments [String] :delimiter The character to use between values within a CSV row.
-        #  It is valid only for the CSV format.
+        #  It is valid only for the CSV format. Server default: ,.
         # @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.
         #  If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.
         # @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.For async requests, nothing will be returned if the async query doesn't finish within the timeout.

data/lib/elasticsearch/api/actions/esql/get_query.rb

@@ -43,7 +43,7 @@ module Elasticsearch
         #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see [TODO]
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-get-query
         #
         def get_query(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'esql.get_query' }

data/lib/elasticsearch/api/actions/esql/list_queries.rb

@@ -42,7 +42,7 @@ module Elasticsearch
         #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see [TODO]
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-list-queries
         #
         def list_queries(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'esql.list_queries' }

data/lib/elasticsearch/api/actions/esql/query.rb

@@ -29,7 +29,7 @@ module Elasticsearch
         # library is upgraded.
         #
         # @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.
-        # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the CSV format.
+        # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the CSV format. Server default: ,.
         # @option arguments [Boolean] :drop_null_columns Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?
         #  Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns.
         # @option arguments [Boolean] :allow_partial_results If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.

data/lib/elasticsearch/api/actions/fleet/msearch.rb

@@ -108,9 +108,7 @@ module Elasticsearch
             payload = body
           end
 
-          headers.merge!({
-                           'Content-Type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9'
-                         })
+          Utils.update_ndjson_headers!(headers, client.transport.options.dig(:transport_options, :headers))
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, payload, headers, request_opts)
           )

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

@@ -27,7 +27,7 @@ module Elasticsearch
       # @option arguments [String] :id The identifier for the stored script or search template. (*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.
-      #  It can also be set to `-1` to indicate that the request should never timeout. Server default: .
+      #  It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s.
       # @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

data/lib/elasticsearch/api/actions/indices/create_from.rb

@@ -55,7 +55,6 @@ module Elasticsearch
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'source' missing" unless arguments[:source]
           raise ArgumentError, "Required argument 'dest' missing" unless arguments[:dest]
 

data/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb

@@ -27,7 +27,7 @@ module Elasticsearch
         #
         # @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams (*Required*)
         # @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open)
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
         # @option arguments [Time] :timeout Explicit timestamp for the document
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
         #  when they occur.

data/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb

@@ -27,7 +27,7 @@ module Elasticsearch
         #
         # @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream options will be deleted; use `*` to get all data streams (*Required*)
         # @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open)
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
         # @option arguments [Time] :timeout Explicit timestamp for the document
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
         #  when they occur.
@@ -42,7 +42,7 @@ module Elasticsearch
         #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream-options
         #
         def delete_data_stream_options(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_data_stream_options' }

data/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb

@@ -27,7 +27,7 @@ module Elasticsearch
         #
         # @option arguments [String, Array] :index The name of the index to explain (*Required*)
         # @option arguments [Boolean] :include_defaults indicates if the API should return the default values the system uses for the index's lifecycle
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
         # @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

data/lib/elasticsearch/api/actions/indices/forcemerge.rb

@@ -70,7 +70,7 @@ module Elasticsearch
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @option arguments [Integer] :max_num_segments The number of segments the index should be merged into (default: dynamic)
         # @option arguments [Boolean] :only_expunge_deletes Specify whether the operation should only expunge deleted documents
-        # @option arguments [Boolean] :wait_for_completion Should the request wait until the force merge is completed.
+        # @option arguments [Boolean] :wait_for_completion Should the request wait until the force merge is completed. Server default: true.
         # @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

data/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb

@@ -44,7 +44,7 @@ module Elasticsearch
         #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream-options
         #
         def get_data_stream_options(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_stream_options' }

data/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb

@@ -49,7 +49,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-stream-options
         #
         def put_data_stream_options(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'indices.put_data_stream_options' }

data/lib/elasticsearch/api/actions/indices/put_index_template.rb

@@ -48,7 +48,7 @@ module Elasticsearch
         # @option arguments [Boolean] :create If `true`, this request cannot replace or update existing index templates.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
         #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
-        # @option arguments [String] :cause User defined reason for creating/updating the index template
+        # @option arguments [String] :cause User defined reason for creating/updating the index template Server default: api.
         # @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

data/lib/elasticsearch/api/actions/indices/put_mapping.rb

@@ -32,7 +32,7 @@ module Elasticsearch
         # - Update supported mapping parameters
         # - Change a field's mapping using reindexing
         # - Rename a field using a field alias
-        # Learn how to use the update mapping API with practical examples in the {https://www.elastic.co/docs//manage-data/data-store/mapping/update-mappings-examples Update mapping API examples} guide.
+        # Learn how to use the update mapping API with practical examples in the {https://www.elastic.co/docs/manage-data/data-store/mapping/update-mappings-examples Update mapping API examples} guide.
         #
         # @option arguments [String, Array] :index A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. (*Required*)
         # @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.

data/lib/elasticsearch/api/actions/indices/put_template.rb

@@ -45,7 +45,7 @@ module Elasticsearch
         # @option arguments [Integer] :order Order in which Elasticsearch applies this template if index
         #  matches multiple templates.Templates with lower 'order' values are merged first. Templates with higher
         #  'order' values are merged later, overriding templates with lower values.
-        # @option arguments [String] :cause User defined reason for creating/updating the index template
+        # @option arguments [String] :cause User defined reason for creating/updating the index template Server default: .
         # @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

data/lib/elasticsearch/api/actions/indices/refresh.rb

@@ -27,6 +27,7 @@ module Elasticsearch
         # For data streams, the API runs the refresh operation on the stream’s backing indices.
         # By default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds.
         # You can change this default interval with the `index.refresh_interval` setting.
+        # In Elastic Cloud Serverless, the default refresh interval is 5 seconds across all indices.
         # Refresh requests are synchronous and do not return a response until the refresh operation completes.
         # Refreshes are resource-intensive.
         # To ensure good cluster performance, it's recommended to wait for Elasticsearch's periodic refresh rather than performing an explicit refresh when possible.

data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb

@@ -42,6 +42,7 @@ module Elasticsearch
         # @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 index_template
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-index-template
         #
@@ -58,7 +59,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body = nil
+          body = arguments.delete(:body)
 
           _name = arguments.delete(:name)
 

data/lib/elasticsearch/api/actions/indices/simulate_template.rb

@@ -28,7 +28,7 @@ module Elasticsearch
         # @option arguments [String] :name Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit
         #  this parameter and specify the template configuration in the request body.
         # @option arguments [Boolean] :create If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.
-        # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes
+        # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes Server default: false.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Boolean] :include_defaults If true, returns all relevant default configurations for the index template.
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

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

@@ -43,7 +43,7 @@ module Elasticsearch
         # @option arguments [String, Array<String>] :groups Comma-separated list of search groups to include in the search statistics.
         # @option arguments [Boolean] :include_segment_file_sizes If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
         # @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory.
-        # @option arguments [String] :level Indicates whether statistics are aggregated at the cluster, index, or shard level.
+        # @option arguments [String] :level Indicates whether statistics are aggregated at the cluster, indices, or shards level. Server default: indices.
         # @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

data/lib/elasticsearch/api/actions/inference/put.rb

@@ -34,17 +34,18 @@ module Elasticsearch
         # * Azure AI Studio (`completion`, `text_embedding`)
         # * Azure OpenAI (`completion`, `text_embedding`)
         # * Cohere (`completion`, `rerank`, `text_embedding`)
-        # * DeepSeek (`completion`, `chat_completion`)
+        # * DeepSeek (`chat_completion`, `completion`)
         # * Elasticsearch (`rerank`, `sparse_embedding`, `text_embedding` - this service is for built-in models and models uploaded through Eland)
         # * ELSER (`sparse_embedding`)
         # * Google AI Studio (`completion`, `text_embedding`)
-        # * Google Vertex AI (`rerank`, `text_embedding`)
+        # * Google Vertex AI (`chat_completion`, `completion`, `rerank`, `text_embedding`)
         # * Hugging Face (`chat_completion`, `completion`, `rerank`, `text_embedding`)
+        # * JinaAI (`rerank`, `text_embedding`)
+        # * Llama (`chat_completion`, `completion`, `text_embedding`)
         # * Mistral (`chat_completion`, `completion`, `text_embedding`)
         # * OpenAI (`chat_completion`, `completion`, `text_embedding`)
-        # * VoyageAI (`text_embedding`, `rerank`)
+        # * VoyageAI (`rerank`, `text_embedding`)
         # * Watsonx inference integration (`text_embedding`)
-        # * JinaAI (`text_embedding`, `rerank`)
         #
         # @option arguments [String] :task_type The task type. Refer to the integration list in the API description for the available task types.
         # @option arguments [String] :inference_id The inference Id (*Required*)

data/lib/elasticsearch/api/actions/logstash/put_pipeline.rb

@@ -26,7 +26,8 @@ module Elasticsearch
         # Create a pipeline that is used for Logstash Central Management.
         # If the specified pipeline exists, it is replaced.
         #
-        # @option arguments [String] :id An identifier for the pipeline. (*Required*)
+        # @option arguments [String] :id An identifier for the pipeline.
+        #  Pipeline IDs must begin with a letter or underscore and contain only letters, underscores, dashes, hyphens and numbers. (*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

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

@@ -120,9 +120,7 @@ module Elasticsearch
           payload = body
         end
 
-        headers.merge!({
-                         'Content-Type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9'
-                       })
+        Utils.update_ndjson_headers!(headers, transport.options.dig(:transport_options, :headers))
         Elasticsearch::API::Response.new(
           perform_request(method, path, params, payload, headers, request_opts)
         )

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

@@ -93,9 +93,7 @@ module Elasticsearch
           payload = body
         end
 
-        headers.merge!({
-                         'Content-Type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9'
-                       })
+        Utils.update_ndjson_headers!(headers, transport.options.dig(:transport_options, :headers))
         Elasticsearch::API::Response.new(
           perform_request(method, path, params, payload, headers, request_opts)
         )

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

@@ -34,7 +34,7 @@ module Elasticsearch
         # @option arguments [String, Array<String>] :fields Comma-separated list or wildcard expressions of fields to include in the statistics.
         # @option arguments [Boolean] :groups Comma-separated list of search groups to include in the search statistics.
         # @option arguments [Boolean] :include_segment_file_sizes If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
-        # @option arguments [String] :level Indicates whether statistics are aggregated at the cluster, index, or shard level.
+        # @option arguments [String] :level Indicates whether statistics are aggregated at the node, indices, or shards level. Server default: node.
         # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Array<String>] :types A comma-separated list of document types for the indexing index metric.
         # @option arguments [Boolean] :include_unloaded_segments If `true`, the response includes information from segments that are not loaded into memory.