Skip to content

Commit ec49951

Browse files
committed
[API] Updates parameters and source code documentation
indices.rollover - removes target_failure_store license.post_start_trial - removes timeout shutdown.delete_node, shutdown.put_node - adds master_timeout, timeout xpack.info - adds human parameter, defines whether additional human-readable information is included in the response. In par ticular, it adds descriptions and a tag line. The default value is true.
1 parent 16dfbe5 commit ec49951

File tree

5 files changed

+7
-4
lines changed

5 files changed

+7
-4
lines changed

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ module Actions
3232
# @option arguments [Time] :master_timeout Specify timeout for connection to master
3333
# @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the newly created rollover index before the operation returns.
3434
# @option arguments [Boolean] :lazy If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams.
35-
# @option arguments [Boolean] :target_failure_store If set to true, the rollover action will be applied on the failure store of the data stream.
3635
# @option arguments [Hash] :headers Custom HTTP headers
3736
# @option arguments [Hash] :body The conditions that needs to be met for executing rollover
3837
#

elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ module Actions
2727
# @option arguments [String] :type The type of trial license to generate (default: "trial")
2828
# @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false)
2929
# @option arguments [Time] :master_timeout Timeout for processing on master node
30-
# @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster
3130
# @option arguments [Hash] :headers Custom HTTP headers
3231
#
3332
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/start-trial.html

elasticsearch-api/lib/elasticsearch/api/actions/shutdown/delete_node.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ module Actions
2525
# Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
2626
#
2727
# @option arguments [String] :node_id The node id of node to be removed from the shutdown state
28+
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
29+
# @option arguments [Time] :timeout Explicit operation timeout
2830
# @option arguments [Hash] :headers Custom HTTP headers
2931
#
3032
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current
@@ -48,7 +50,7 @@ def delete_node(arguments = {})
4850

4951
method = Elasticsearch::API::HTTP_DELETE
5052
path = "_nodes/#{Utils.__listify(_node_id)}/shutdown"
51-
params = {}
53+
params = Utils.process_params(arguments)
5254

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

elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ module Actions
2525
# Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
2626
#
2727
# @option arguments [String] :node_id The node id of node to be shut down
28+
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
29+
# @option arguments [Time] :timeout Explicit operation timeout
2830
# @option arguments [Hash] :headers Custom HTTP headers
2931
# @option arguments [Hash] :body The shutdown type definition to register (*Required*)
3032
#
@@ -50,7 +52,7 @@ def put_node(arguments = {})
5052

5153
method = Elasticsearch::API::HTTP_PUT
5254
path = "_nodes/#{Utils.__listify(_node_id)}/shutdown"
53-
params = {}
55+
params = Utils.process_params(arguments)
5456

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

elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ module XPack
2424
module Actions
2525
# Retrieves information about the installed X-Pack features.
2626
#
27+
# @option arguments [Boolean] :human Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line. The default value is true.
2728
# @option arguments [List] :categories Comma-separated list of info categories. Can be any of: build, license, features
2829
# @option arguments [Boolean] :accept_enterprise If this param is used it must be set to true *Deprecated*
2930
# @option arguments [Hash] :headers Custom HTTP headers

0 commit comments

Comments
 (0)