lib/elasticsearch/api/actions/cat/indices.rb in elasticsearch-api-7.9.0.pre vs lib/elasticsearch/api/actions/cat/indices.rb in elasticsearch-api-7.9.0
- old
+ new
@@ -21,32 +21,24 @@
module Actions
# Returns information about indices: number of primaries and replicas, document counts, disk size, ...
#
# @option arguments [List] :index A comma-separated list of index names to limit the returned information
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
- # @option arguments [String] :bytes The unit in which to display byte values
- # (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
-
+ # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [List] :h Comma-separated list of column names to display
- # @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status
- # (options: green,yellow,red)
-
+ # @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (options: green, yellow, red)
# @option arguments [Boolean] :help Return help information
# @option arguments [Boolean] :pri Set to true to return stats only for primary shards
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
- # @option arguments [String] :time The unit in which to display time values
- # (options: d,h,m,s,ms,micros,nanos)
-
+ # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory
- # @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)
-
+ # @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)
# @option arguments [Hash] :headers Custom HTTP headers
#
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-indices.html
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-indices.html
#
def indices(arguments = {})
headers = arguments.delete(:headers) || {}
arguments = arguments.clone