Skip to content

Commit 76d66e4

Browse files
committed
[API] Updates API specification to eeef9c87c1273e5dd3a5a313768bfa6728cd39cc
- Updates source code docs links - Updates transform.set_upgrade_mode
1 parent f52b32c commit 76d66e4

File tree

8 files changed

+37
-10
lines changed

8 files changed

+37
-10
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ module Actions
4343
# this option for debugging only.
4444
# @option arguments [Hash] :headers Custom HTTP headers
4545
#
46-
# @see [TODO]
46+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-get-query
4747
#
4848
def get_query(arguments = {})
4949
request_opts = { endpoint: arguments[:endpoint] || 'esql.get_query' }

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ module Actions
4242
# this option for debugging only.
4343
# @option arguments [Hash] :headers Custom HTTP headers
4444
#
45-
# @see [TODO]
45+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-list-queries
4646
#
4747
def list_queries(arguments = {})
4848
request_opts = { endpoint: arguments[:endpoint] || 'esql.list_queries' }

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ module Actions
4242
# this option for debugging only.
4343
# @option arguments [Hash] :headers Custom HTTP headers
4444
#
45-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
45+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream-options
4646
#
4747
def delete_data_stream_options(arguments = {})
4848
request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_data_stream_options' }

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ module Actions
4444
# this option for debugging only.
4545
# @option arguments [Hash] :headers Custom HTTP headers
4646
#
47-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
47+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream-options
4848
#
4949
def get_data_stream_options(arguments = {})
5050
request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_stream_options' }

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ module Actions
4949
# @option arguments [Hash] :headers Custom HTTP headers
5050
# @option arguments [Hash] :body request body
5151
#
52-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
52+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-stream-options
5353
#
5454
def put_data_stream_options(arguments = {})
5555
request_opts = { endpoint: arguments[:endpoint] || 'indices.put_data_stream_options' }

elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ module Actions
5353
# 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.
5454
# It's recommended to reindex on indices with a green status. Reindexing can fail when a node shuts down or crashes.
5555
# * When requested with `wait_for_completion=true` (default), the request fails if the node shuts down.
56-
# * 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.
56+
# * 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.
5757
# When retrying a failed reindex operation, it might be necessary to set `conflicts=proceed` or to first delete the partial destination index.
5858
# Additionally, dry runs, checking disk space, and fetching index recovery information can help address the root cause.
5959
# Refer to the linked documentation for examples of how to reindex documents.

elasticsearch-api/lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,38 @@ module Elasticsearch
2222
module API
2323
module Transform
2424
module Actions
25-
# Sets a cluster wide upgrade_mode setting that prepares transform indices for an upgrade.
25+
# Set upgrade_mode for transform indices.
26+
# Sets a cluster wide upgrade_mode setting that prepares transform
27+
# indices for an upgrade.
28+
# When upgrading your cluster, in some circumstances you must restart your
29+
# nodes and reindex your transform indices. In those circumstances,
30+
# there must be no transforms running. You can close the transforms,
31+
# do the upgrade, then open all the transforms again. Alternatively,
32+
# you can use this API to temporarily halt tasks associated with the transforms
33+
# and prevent new transforms from opening. You can also use this API
34+
# during upgrades that do not require you to reindex your transform
35+
# indices, though stopping transforms is not a requirement in that case.
36+
# You can see the current value for the upgrade_mode setting by using the get
37+
# transform info API.
2638
#
39+
# @option arguments [Boolean] :enabled When `true`, it enables `upgrade_mode` which temporarily halts all
40+
# transform tasks and prohibits new transform tasks from
41+
# starting.
42+
# @option arguments [Time] :timeout The time to wait for the request to be completed. Server default: 30s.
43+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
44+
# when they occur.
45+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
46+
# returned by Elasticsearch.
47+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
48+
# For example `"exists_time": "1h"` for humans and
49+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
50+
# readable values will be omitted. This makes sense for responses being consumed
51+
# only by machines.
52+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
53+
# this option for debugging only.
2754
# @option arguments [Hash] :headers Custom HTTP headers
2855
#
29-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/transform-set-upgrade-mode.html
56+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-set-upgrade-mode
3057
#
3158
def set_upgrade_mode(arguments = {})
3259
request_opts = { endpoint: arguments[:endpoint] || 'transform.set_upgrade_mode' }
@@ -38,7 +65,7 @@ def set_upgrade_mode(arguments = {})
3865

3966
method = Elasticsearch::API::HTTP_POST
4067
path = '_transform/set_upgrade_mode'
41-
params = {}
68+
params = Utils.process_params(arguments)
4269

4370
Elasticsearch::API::Response.new(
4471
perform_request(method, path, params, body, headers, request_opts)

elasticsearch-api/lib/elasticsearch/api/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@
1818
module Elasticsearch
1919
module API
2020
VERSION = '9.1.1'.freeze
21-
ES_SPECIFICATION_COMMIT = 'c87b1a22e846cc829f8d06c4958b0d2418b51375'.freeze
21+
ES_SPECIFICATION_COMMIT = 'eeef9c87c1273e5dd3a5a313768bfa6728cd39cc'.freeze
2222
end
2323
end

0 commit comments

Comments
 (0)