Skip to content

Commit ff90a4c

Browse files
committed
[API] Regenerate code with doc improvements
1 parent 123a24e commit ff90a4c

Some content is hidden

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

75 files changed

+125
-226
lines changed

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ module Actions
2323
# @option arguments [String] :index Default index for items which don't provide one
2424
# @option arguments [String] :type Default document type for items which don't provide one
2525
# @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
26-
# @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.
27-
# (options: true,false,wait_for)
26+
# @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
2827
# @option arguments [String] :routing Specific routing value
2928
# @option arguments [Time] :timeout Explicit operation timeout
3029
# @option arguments [String] :type Default document type for items which don't provide one

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ module Actions
2828
# @option arguments [Boolean] :help Return help information
2929
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
3030
# @option arguments [Boolean] :v Verbose mode. Display column headers
31-
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
32-
# (options: open,closed,hidden,none,all)
31+
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
3332
# @option arguments [Hash] :headers Custom HTTP headers
3433
#
3534
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-alias.html

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ module Actions
2323
#
2424
# @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information
2525
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
26-
# @option arguments [String] :bytes The unit in which to display byte values
27-
# (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
26+
# @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
2827
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
2928
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
3029
# @option arguments [List] :h Comma-separated list of column names to display

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ module Actions
2323
#
2424
# @option arguments [List] :fields A comma-separated list of fields to return the fielddata size
2525
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
26-
# @option arguments [String] :bytes The unit in which to display byte values
27-
# (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
26+
# @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
2827
# @option arguments [List] :h Comma-separated list of column names to display
2928
# @option arguments [Boolean] :help Return help information
3029
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ module Actions
2525
# @option arguments [List] :h Comma-separated list of column names to display
2626
# @option arguments [Boolean] :help Return help information
2727
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
28-
# @option arguments [String] :time The unit in which to display time values
29-
# (options: d,h,m,s,ms,micros,nanos)
28+
# @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
3029
# @option arguments [Boolean] :ts Set to false to disable timestamping
3130
# @option arguments [Boolean] :v Verbose mode. Display column headers
3231
# @option arguments [Hash] :headers Custom HTTP headers

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

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,18 @@ module Actions
2323
#
2424
# @option arguments [List] :index A comma-separated list of index names to limit the returned information
2525
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
26-
# @option arguments [String] :bytes The unit in which to display byte values
27-
# (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
26+
# @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
2827
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
2928
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
3029
# @option arguments [List] :h Comma-separated list of column names to display
31-
# @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status
32-
# (options: green,yellow,red)
30+
# @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (options: green, yellow, red)
3331
# @option arguments [Boolean] :help Return help information
3432
# @option arguments [Boolean] :pri Set to true to return stats only for primary shards
3533
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
36-
# @option arguments [String] :time The unit in which to display time values
37-
# (options: d,h,m,s,ms,micros,nanos)
34+
# @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
3835
# @option arguments [Boolean] :v Verbose mode. Display column headers
3936
# @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory
40-
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
41-
# (options: open,closed,hidden,none,all)
37+
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
4238
# @option arguments [Hash] :headers Custom HTTP headers
4339
#
4440
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-indices.html

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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,15 @@ module Cat
2121
module Actions
2222
# Returns basic statistics about performance of cluster nodes.
2323
#
24-
# @option arguments [String] :bytes The unit in which to display byte values
25-
# (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
24+
# @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
2625
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
2726
# @option arguments [Boolean] :full_id Return the full node ID instead of the shortened version (default: false)
28-
# @option arguments [Boolean] :local Calculate the selected nodes using the local cluster state rather than the state from master node (default: false) *Deprecated*
27+
# @option arguments [Boolean] :local Calculate the selected nodes using the local cluster state rather than the state from master node (default: false) *Deprecated*
2928
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
3029
# @option arguments [List] :h Comma-separated list of column names to display
3130
# @option arguments [Boolean] :help Return help information
3231
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
33-
# @option arguments [String] :time The unit in which to display time values
34-
# (options: d,h,m,s,ms,micros,nanos)
32+
# @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
3533
# @option arguments [Boolean] :v Verbose mode. Display column headers
3634
# @option arguments [Hash] :headers Custom HTTP headers
3735
#

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ module Actions
2727
# @option arguments [List] :h Comma-separated list of column names to display
2828
# @option arguments [Boolean] :help Return help information
2929
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
30-
# @option arguments [String] :time The unit in which to display time values
31-
# (options: d,h,m,s,ms,micros,nanos)
30+
# @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
3231
# @option arguments [Boolean] :v Verbose mode. Display column headers
3332
# @option arguments [Hash] :headers Custom HTTP headers
3433
#

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,13 @@ module Actions
2424
# @option arguments [List] :index Comma-separated list or wildcard expression of index names to limit the returned information
2525
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
2626
# @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries
27-
# @option arguments [String] :bytes The unit in which to display byte values
28-
# (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
27+
# @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
2928
# @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries
3029
# @option arguments [List] :h Comma-separated list of column names to display
3130
# @option arguments [Boolean] :help Return help information
3231
# @option arguments [List] :index Comma-separated list or wildcard expression of index names to limit the returned information
3332
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
34-
# @option arguments [String] :time The unit in which to display time values
35-
# (options: d,h,m,s,ms,micros,nanos)
33+
# @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
3634
# @option arguments [Boolean] :v Verbose mode. Display column headers
3735
# @option arguments [Hash] :headers Custom HTTP headers
3836
#

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ module Actions
2323
#
2424
# @option arguments [List] :index A comma-separated list of index names to limit the returned information
2525
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
26-
# @option arguments [String] :bytes The unit in which to display byte values
27-
# (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
26+
# @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
2827
# @option arguments [List] :h Comma-separated list of column names to display
2928
# @option arguments [Boolean] :help Return help information
3029
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by

0 commit comments

Comments
 (0)