Skip to content

Commit 10b9a17

Browse files
committed
[API] Reinstates common params in source code documentation
1 parent 6331d7e commit 10b9a17

File tree

513 files changed

+5810
-167
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

513 files changed

+5810
-167
lines changed

elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,17 @@ module Actions
2828
# If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.
2929
#
3030
# @option arguments [String] :id A unique identifier for the async search. (*Required*)
31+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
32+
# when they occur.
33+
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
34+
# returned by Elasticsearch.
35+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
36+
# For example `"exists_time": "1h"` for humans and
37+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
38+
# readable values will be omitted. This makes sense for responses being consumed
39+
# only by machines.
40+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
41+
# this option for debugging only.
3142
# @option arguments [Hash] :headers Custom HTTP headers
3243
#
3344
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit
@@ -51,7 +62,7 @@ def delete(arguments = {})
5162

5263
method = Elasticsearch::API::HTTP_DELETE
5364
path = "_async_search/#{Utils.listify(_id)}"
54-
params = {}
65+
params = Utils.process_params(arguments)
5566

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

elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,17 @@ module Actions
3636
# @option arguments [Time] :wait_for_completion_timeout Specifies to wait for the search to be completed up until the provided timeout.
3737
# Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.
3838
# By default no timeout is set meaning that the currently available results will be returned without any additional wait.
39+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
40+
# when they occur.
41+
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
42+
# returned by Elasticsearch.
43+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
44+
# For example `"exists_time": "1h"` for humans and
45+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
46+
# readable values will be omitted. This makes sense for responses being consumed
47+
# only by machines.
48+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
49+
# this option for debugging only.
3950
# @option arguments [Hash] :headers Custom HTTP headers
4051
#
4152
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit

elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,17 @@ module Actions
3131
# @option arguments [String] :id A unique identifier for the async search. (*Required*)
3232
# @option arguments [Time] :keep_alive The length of time that the async search needs to be available.
3333
# Ongoing async searches and any saved search results are deleted after this period. Server default: 5d.
34+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
35+
# when they occur.
36+
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
37+
# returned by Elasticsearch.
38+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
39+
# For example `"exists_time": "1h"` for humans and
40+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
41+
# readable values will be omitted. This makes sense for responses being consumed
42+
# only by machines.
43+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
44+
# this option for debugging only.
3445
# @option arguments [Hash] :headers Custom HTTP headers
3546
#
3647
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit

elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,17 @@ module Actions
7575
# @option arguments [Integer] :size Number of hits to return (default: 10)
7676
# @option arguments [Integer] :from Starting offset (default: 0)
7777
# @option arguments [String] :sort A comma-separated list of <field>:<direction> pairs
78+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
79+
# when they occur.
80+
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
81+
# returned by Elasticsearch.
82+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
83+
# For example `"exists_time": "1h"` for humans and
84+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
85+
# readable values will be omitted. This makes sense for responses being consumed
86+
# only by machines.
87+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
88+
# this option for debugging only.
7889
# @option arguments [Hash] :headers Custom HTTP headers
7990
# @option arguments [Hash] :body request body
8091
#

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,17 @@ module Actions
137137
# The default is `1`, which waits for each primary shard to be active. Server default: 1.
138138
# @option arguments [Boolean] :require_alias If `true`, the request's actions must target an index alias.
139139
# @option arguments [Boolean] :require_data_stream If `true`, the request's actions must target a data stream (existing or to be created).
140+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
141+
# when they occur.
142+
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
143+
# returned by Elasticsearch.
144+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
145+
# For example `"exists_time": "1h"` for humans and
146+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
147+
# readable values will be omitted. This makes sense for responses being consumed
148+
# only by machines.
149+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
150+
# this option for debugging only.
140151
# @option arguments [Hash] :headers Custom HTTP headers
141152
# @option arguments [String|Array] :body operations. Array of Strings, Header/Data pairs, or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.bulkify documentation.
142153
#

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,17 @@ module Actions
4343
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
4444
# can't be combined with any other query string option.
4545
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
46+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
47+
# when they occur.
48+
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
49+
# returned by Elasticsearch.
50+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
51+
# For example `"exists_time": "1h"` for humans and
52+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
53+
# readable values will be omitted. This makes sense for responses being consumed
54+
# only by machines.
55+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
56+
# this option for debugging only.
4657
# @option arguments [Hash] :headers Custom HTTP headers
4758
#
4859
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,17 @@ module Actions
4242
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
4343
# can't be combined with any other query string option.
4444
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
45+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
46+
# when they occur.
47+
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
48+
# returned by Elasticsearch.
49+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
50+
# For example `"exists_time": "1h"` for humans and
51+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
52+
# readable values will be omitted. This makes sense for responses being consumed
53+
# only by machines.
54+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
55+
# this option for debugging only.
4556
# @option arguments [Hash] :headers Custom HTTP headers
4657
#
4758
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-allocation

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,17 @@ module Actions
4545
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
4646
# can't be combined with any other query string option.
4747
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
48+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
49+
# when they occur.
50+
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
51+
# returned by Elasticsearch.
52+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
53+
# For example `"exists_time": "1h"` for humans and
54+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
55+
# readable values will be omitted. This makes sense for responses being consumed
56+
# only by machines.
57+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
58+
# this option for debugging only.
4859
# @option arguments [Hash] :headers Custom HTTP headers
4960
#
5061
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,17 @@ module Actions
4040
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
4141
# can't be combined with any other query string option.
4242
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
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] :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+
# `"eixsts_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.
4354
# @option arguments [Hash] :headers Custom HTTP headers
4455
#
4556
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,17 @@ module Actions
3939
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
4040
# can't be combined with any other query string option.
4141
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
42+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
43+
# when they occur.
44+
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
45+
# returned by Elasticsearch.
46+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
47+
# For example `"exists_time": "1h"` for humans and
48+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
49+
# readable values will be omitted. This makes sense for responses being consumed
50+
# only by machines.
51+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
52+
# this option for debugging only.
4253
# @option arguments [Hash] :headers Custom HTTP headers
4354
#
4455
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-fielddata

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,17 @@ module Actions
4444
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
4545
# can't be combined with any other query string option.
4646
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
47+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
48+
# when they occur.
49+
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
50+
# returned by Elasticsearch.
51+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
52+
# For example `"exists_time": "1h"` for humans and
53+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
54+
# readable values will be omitted. This makes sense for responses being consumed
55+
# only by machines.
56+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
57+
# this option for debugging only.
4758
# @option arguments [Hash] :headers Custom HTTP headers
4859
#
4960
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-health

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,17 @@ module Actions
5353
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
5454
# can't be combined with any other query string option.
5555
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
56+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
57+
# when they occur.
58+
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
59+
# returned by Elasticsearch.
60+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
61+
# For example `"exists_time": "1h"` for humans and
62+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
63+
# readable values will be omitted. This makes sense for responses being consumed
64+
# only by machines.
65+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
66+
# this option for debugging only.
5667
# @option arguments [Hash] :headers Custom HTTP headers
5768
#
5869
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,17 @@ module Actions
4040
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
4141
# can't be combined with any other query string option.
4242
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
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] :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+
# `"eixsts_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.
4354
# @option arguments [Hash] :headers Custom HTTP headers
4455
#
4556
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-master

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,17 @@ module Actions
4040
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
4141
# can't be combined with any other query string option.
4242
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
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] :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+
# `"eixsts_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.
4354
# @option arguments [Hash] :headers Custom HTTP headers
4455
#
4556
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-data-frame-analytics

0 commit comments

Comments
 (0)