From ce832449a02dca5c7b12a3c294fe596d74b7cb35 Mon Sep 17 00:00:00 2001 From: Fernando Briano Date: Thu, 11 Sep 2025 15:44:19 +0100 Subject: [PATCH] [API] Generates e194c704d2949312ed19e0582c29a873beee68db --- .../elasticsearch/api/actions/cat/health.rb | 2 +- .../elasticsearch/api/actions/cat/indices.rb | 2 +- .../elasticsearch/api/actions/cat/master.rb | 2 +- .../api/actions/cat/nodeattrs.rb | 2 +- .../api/actions/cat/pending_tasks.rb | 2 +- .../elasticsearch/api/actions/cat/plugins.rb | 2 +- .../elasticsearch/api/actions/cat/tasks.rb | 2 +- .../api/actions/cat/templates.rb | 2 +- .../api/actions/indices/rollover.rb | 2 +- .../lib/elasticsearch/api/actions/reindex.rb | 2 +- .../api/actions/transform/get_node_stats.rb | 2 +- .../api/actions/transform/set_upgrade_mode.rb | 33 +++++++++++++++++-- .../lib/elasticsearch/api/version.rb | 2 +- 13 files changed, 42 insertions(+), 15 deletions(-) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb index 82a312faa2..d0b4b83b84 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb @@ -35,7 +35,7 @@ module Actions # # @option arguments [String] :time The unit used to display time values. # @option arguments [Boolean] :ts If true, returns `HH:MM:SS` and Unix epoch timestamps. Server default: true. - # @option arguments [String, Array] :h List of columns to appear in the response. Supports simple wildcards. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. # @option arguments [String, Array] :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. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb index f18a1c87dc..3d64ac82be 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb @@ -44,7 +44,7 @@ module Actions # @option arguments [Boolean] :pri If true, the response only includes information from primary shards. # @option arguments [String] :time The unit used to display time values. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. - # @option arguments [String, Array] :h List of columns to appear in the response. Supports simple wildcards. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. # @option arguments [String, Array] :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. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb index 24c7e73bac..bab7a71a5b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb @@ -26,7 +26,7 @@ module Actions # Get information about the master node, including the ID, bound IP address, and name. # IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. # - # @option arguments [String, Array] :h List of columns to appear in the response. Supports simple wildcards. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. # @option arguments [String, Array] :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. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb index 55b48c7d80..b8a66fe596 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb @@ -26,7 +26,7 @@ module Actions # Get information about custom node attributes. # IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. # - # @option arguments [String, Array] :h List of columns to appear in the response. Supports simple wildcards. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. # @option arguments [String, Array] :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. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb index a88815532b..8a536c501b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb @@ -26,7 +26,7 @@ module Actions # Get information about cluster-level changes that have not yet taken effect. # IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API. # - # @option arguments [String, Array] :h List of columns to appear in the response. Supports simple wildcards. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. # @option arguments [String, Array] :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. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb index b84bc683a4..c47fecbf32 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb @@ -26,7 +26,7 @@ module Actions # Get a list of plugins running on each node of a cluster. # IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. # - # @option arguments [String, Array] :h List of columns to appear in the response. Supports simple wildcards. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. # @option arguments [String, Array] :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. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb index 9c9597f2f7..5e12fcecd8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb @@ -34,7 +34,7 @@ module Actions # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries. # @option arguments [Array] :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] :h List of columns to appear in the response. Supports simple wildcards. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. # @option arguments [String, Array] :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. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb index 112ae65ac2..89a74aacf1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb @@ -29,7 +29,7 @@ module Actions # # @option arguments [String] :name The name of the template to return. # Accepts wildcard expressions. If omitted, all templates are returned. - # @option arguments [String, Array] :h List of columns to appear in the response. Supports simple wildcards. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. # @option arguments [String, Array] :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. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb index 9789dc0919..2ac0d72b11 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb @@ -23,7 +23,7 @@ module API module Indices module Actions # Roll over to a new index. - # TIP: It is recommended to use the index lifecycle rollover action to automate rollovers. + # TIP: We recommend using the index lifecycle rollover action to automate rollovers. However, Serverless does not support Index Lifecycle Management (ILM), so don't use this approach in the Serverless context. # The rollover API creates a new index for a data stream or index alias. # The API behavior depends on the rollover target. # **Roll over a data stream** diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb b/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb index 20e69a4e01..4c0e24bd60 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb @@ -53,7 +53,7 @@ module Actions # Additionally, if you opt to count version conflicts, the operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query. # It's recommended to reindex on indices with a green status. Reindexing can fail when a node shuts down or crashes. # * When requested with `wait_for_completion=true` (default), the request fails if the node shuts down. - # * When requested with `wait_for_completion=false`, a task id is returned, which can be used via the task management API to monitor, debug, or cancel the task. The task may disappear or fail if the node shuts down. + # * When requested with `wait_for_completion=false`, a task id is returned, for use with the task management APIs. The task may disappear or fail if the node shuts down. # When retrying a failed reindex operation, it might be necessary to set `conflicts=proceed` or to first delete the partial destination index. # Additionally, dry runs, checking disk space, and fetching index recovery information can help address the root cause. # Refer to the linked documentation for examples of how to reindex documents. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_node_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_node_stats.rb index b5629cd085..b87f76f425 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_node_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_node_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Transform module Actions - # Retrieves transform usage information for transform nodes. + # Retrieves transform usage information for transform nodes # # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb index 75c12bc322..a44651f67a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb @@ -22,11 +22,38 @@ module Elasticsearch module API module Transform module Actions - # Sets a cluster wide upgrade_mode setting that prepares transform indices for an upgrade. + # Set upgrade_mode for transform indices. + # Sets a cluster wide upgrade_mode setting that prepares transform + # indices for an upgrade. + # When upgrading your cluster, in some circumstances you must restart your + # nodes and reindex your transform indices. In those circumstances, + # there must be no transforms running. You can close the transforms, + # do the upgrade, then open all the transforms again. Alternatively, + # you can use this API to temporarily halt tasks associated with the transforms + # and prevent new transforms from opening. You can also use this API + # during upgrades that do not require you to reindex your transform + # indices, though stopping transforms is not a requirement in that case. + # You can see the current value for the upgrade_mode setting by using the get + # transform info API. # + # @option arguments [Boolean] :enabled When `true`, it enables `upgrade_mode` which temporarily halts all + # transform tasks and prohibits new transform tasks from + # starting. + # @option arguments [Time] :timeout The time to wait for the request to be completed. 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] :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/guide/en/elasticsearch/reference/current/transform-set-upgrade-mode.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-set-upgrade-mode # def set_upgrade_mode(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.set_upgrade_mode' } @@ -38,7 +65,7 @@ def set_upgrade_mode(arguments = {}) method = Elasticsearch::API::HTTP_POST path = '_transform/set_upgrade_mode' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/version.rb b/elasticsearch-api/lib/elasticsearch/api/version.rb index 9eea9056ec..b527ec2564 100644 --- a/elasticsearch-api/lib/elasticsearch/api/version.rb +++ b/elasticsearch-api/lib/elasticsearch/api/version.rb @@ -18,6 +18,6 @@ module Elasticsearch module API VERSION = '9.0.5'.freeze - ES_SPECIFICATION_COMMIT = '941744bd0826657988ca8f9a336795092b3dbb9b'.freeze + ES_SPECIFICATION_COMMIT = 'e194c704d2949312ed19e0582c29a873beee68db'.freeze end end