Skip to content

Commit 2499a58

Browse files
committed
[API] Updates cat APIs
* cat.help - removes :s and :help parameters * cat.segments - Adds :local and :master_timeout parameters * cat.tasks - Adds :timeout and :wait_for_completion parameters
1 parent 0e12717 commit 2499a58

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb

+1-3
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ module Cat
2424
module Actions
2525
# Returns help for the Cat APIs.
2626
#
27-
# @option arguments [Boolean] :help Return help information
28-
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
2927
# @option arguments [Hash] :headers Custom HTTP headers
3028
#
3129
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat.html
@@ -40,7 +38,7 @@ def help(arguments = {})
4038

4139
method = Elasticsearch::API::HTTP_GET
4240
path = '_cat'
43-
params = Utils.process_params(arguments)
41+
params = {}
4442

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

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

+2
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ module Actions
2626
#
2727
# @option arguments [List] :index A comma-separated list of index names to limit the returned information
2828
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
29+
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
30+
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
2931
# @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
3032
# @option arguments [List] :h Comma-separated list of column names to display
3133
# @option arguments [Boolean] :help Return help information

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

+2
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ module Actions
3838
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
3939
# @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
4040
# @option arguments [Boolean] :v Verbose mode. Display column headers
41+
# @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.
42+
# @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the task has completed.
4143
# @option arguments [Hash] :headers Custom HTTP headers
4244
#
4345
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html

0 commit comments

Comments
 (0)