Skip to content

Commit f808c97

Browse files
committed
[DOCS] Updates API source code documentation
1 parent 7c3778c commit f808c97

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ module Indices
2121
module Actions
2222
# Returns an index template.
2323
#
24-
# @option arguments [List] :name The comma separated names of the index templates
24+
# @option arguments [String] :name A pattern that returned template names must match
2525
# @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
2626
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
2727
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ module Actions
2222
# Returns information about nodes in the cluster.
2323
#
2424
# @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
25-
# @option arguments [List] :metric A comma-separated list of metrics you wish returned. Leave empty to return all. (options: settings, os, process, jvm, thread_pool, transport, http, plugins, ingest)
25+
# @option arguments [List] :metric A comma-separated list of metrics you wish returned. Use `_all` to retrieve all metrics and `_none` to retrieve the node identity without any additional metrics. (options: settings, os, process, jvm, thread_pool, transport, http, plugins, ingest, indices, aggregations, _all, _none)
2626
# @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
2727
# @option arguments [Time] :timeout Explicit operation timeout
2828
# @option arguments [Hash] :headers Custom HTTP headers

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +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; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
2525
# @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, breaker, fs, http, indices, jvm, os, process, thread_pool, transport, discovery, indexing_pressure)
26-
# @option arguments [List] :index_metric Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, suggest, shards)
26+
# @option arguments [List] :index_metric Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, suggest, shard_stats)
2727
# @option arguments [List] :completion_fields A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
2828
# @option arguments [List] :fielddata_fields A comma-separated list of fields for `fielddata` index metric (supports wildcards)
2929
# @option arguments [List] :fields A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)

0 commit comments

Comments
 (0)