diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/get_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/get_query.rb index d01d33691..8db223208 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/get_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/get_query.rb @@ -43,7 +43,7 @@ module Actions # 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' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/list_queries.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/list_queries.rb index 5d083484e..5cb0a44d4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/list_queries.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/list_queries.rb @@ -42,7 +42,7 @@ module Actions # 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' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb index ba2851164..b3e892e6b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb @@ -42,7 +42,7 @@ module Actions # 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' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb index 255fce00e..41b265c32 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb @@ -44,7 +44,7 @@ module Actions # 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' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb index 7d882463f..5c7e4f671 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb @@ -49,7 +49,7 @@ module Actions # @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' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb b/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb index 38b196380..c683d52f5 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/set_upgrade_mode.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb index 75c12bc32..0656bc131 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 + # `"exists_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 26c91ad7a..1b4d097ef 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.1.1'.freeze - ES_SPECIFICATION_COMMIT = 'c87b1a22e846cc829f8d06c4958b0d2418b51375'.freeze + ES_SPECIFICATION_COMMIT = 'eeef9c87c1273e5dd3a5a313768bfa6728cd39cc'.freeze end end