Skip to content

Commit 515eac2

Browse files
committed
[API] Updates source code docs, spec commit 896e37f76add4e8878e9f04205dd8628c7263219
1 parent 3fa78e0 commit 515eac2

Some content is hidden

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

43 files changed

+81
-43
lines changed

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,12 @@ module Actions
3333
# @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries.
3434
# @option arguments [String] :bytes The unit used to display byte values.
3535
# @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
36-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
37-
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
36+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display.
37+
# It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l.
38+
# @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
3839
# Sorting defaults to ascending and can be changed by setting `:asc`
3940
# or `:desc` as a suffix to the column name.
40-
# @option arguments [String] :time Unit used to display time values.
41+
# @option arguments [String] :time The unit used to display time values.
4142
# @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
4243
# `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
4344
# @option arguments [Boolean] :help When set to `true` will output available columns. This option

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,9 @@ module Actions
3131
# Supports wildcards (`*`).
3232
# To target all data streams and indices, omit this parameter or use `*` or `_all`.
3333
# @option arguments [String] :bytes The unit used to display byte values.
34-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
35-
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
34+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display.
35+
# It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l.
36+
# @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
3637
# Sorting defaults to ascending and can be changed by setting `:asc`
3738
# or `:desc` as a suffix to the column name.
3839
# @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ module Actions
3232
# To target all data streams and indices, omit this parameter or use `*` or `_all`.
3333
# @option arguments [String] :bytes The unit used to display byte values.
3434
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
35-
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
35+
# @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
3636
# Sorting defaults to ascending and can be changed by setting `:asc`
3737
# or `:desc` as a suffix to the column name.
38-
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
39-
# @option arguments [String] :time Unit used to display time values.
38+
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
39+
# @option arguments [String] :time The unit used to display time values.
4040
# @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
4141
# `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
4242
# @option arguments [Boolean] :help When set to `true` will output available columns. This option

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ module Actions
3232
# `_all` returns all repositories.
3333
# If any repository fails during the request, Elasticsearch returns an error.
3434
# @option arguments [Boolean] :ignore_unavailable If `true`, the response does not include information from unavailable snapshots.
35-
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
35+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display.
36+
# It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l.
3637
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
3738
# Sorting defaults to ascending and can be changed by setting `:asc`
3839
# or `:desc` as a suffix to the column name.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ module Actions
3030
# @option arguments [String, Array<String>] :thread_pool_patterns A comma-separated list of thread pool names used to limit the request.
3131
# Accepts wildcard expressions.
3232
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
33-
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
33+
# @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
3434
# Sorting defaults to ascending and can be changed by setting `:asc`
3535
# or `:desc` as a suffix to the column name.
3636
# @option arguments [String] :time The unit used to display time values.
3737
# @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the
3838
# local cluster state. If `false` the list of selected nodes are computed
3939
# from the cluster state of the master node. In both cases the coordinating
4040
# node will send requests for further information to each selected node.
41-
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
41+
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
4242
# @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
4343
# `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
4444
# @option arguments [Boolean] :help When set to `true` will output available columns. This option

elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ module Actions
2828
# @option arguments [String] :name Comma-separated list of component template names used to limit the request.
2929
# Wildcard (`*`) expressions are supported.
3030
# @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format.
31+
# @option arguments [String, Array<String>] :settings_filter Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys
3132
# @option arguments [Boolean] :include_defaults Return all default configurations for the component template (default: false)
3233
# @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only.
3334
# If `false`, information is retrieved from the master node.

elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ module Actions
4343
# If you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version.
4444
# If you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API. (*Required*)
4545
# @option arguments [Boolean] :create If `true`, this request cannot replace or update existing component templates.
46+
# @option arguments [String] :cause User defined reason for create the component template. Server default: api.
4647
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
4748
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
4849
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

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

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -77,15 +77,7 @@ module Actions
7777
# @option arguments [String] :index The name of the data stream or index to target.
7878
# If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.
7979
# If the target doesn't exist and doesn’t match a data stream template, this request creates the index. (*Required*)
80-
# @option arguments [Integer] :if_primary_term Only perform the operation if the document has this primary term.
81-
# @option arguments [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
8280
# @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Server default: true.
83-
# @option arguments [String] :op_type Set to `create` to only index the document if it does not already exist (put if absent).
84-
# If a document with the specified `_id` already exists, the indexing operation will fail.
85-
# The behavior is the same as using the `<index>/_create` endpoint.
86-
# If a document ID is specified, this paramater defaults to `index`.
87-
# Otherwise, it defaults to `create`.
88-
# If the request targets a data stream, an `op_type` of `create` is required.
8981
# @option arguments [String] :pipeline The ID of the pipeline to use to preprocess incoming documents.
9082
# If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.
9183
# If a final pipeline is configured, it will always run regardless of the value of this parameter.

elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,12 @@ module Actions
2727
# EQL assumes each document in a data stream or index corresponds to an event.
2828
#
2929
# @option arguments [String, Array] :index The name of the index to scope the operation (*Required*)
30-
# @option arguments [Boolean] :allow_no_indices [TODO] Server default: true.
30+
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) Server default: true.
3131
# @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard failures. If false, returns an error with no partial results. Server default: true.
3232
# @option arguments [Boolean] :allow_partial_sequence_results If true, sequence queries will return partial results in case of shard failures. If false, they will return no results at all.
3333
# This flag has effect only if allow_partial_search_results is true.
34-
# @option arguments [String, Array<String>] :expand_wildcards [TODO] Server default: open.
34+
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open.
35+
# @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution Server default: true.
3536
# @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response. Server default: true.
3637
# @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster. Server default: 5d.
3738
# @option arguments [Boolean] :keep_on_completion If true, the search and its results are stored on the cluster.

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ module Actions
4646
# @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.
4747
# @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude in the response.
4848
# @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
49-
# @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit.
5049
# @option arguments [Integer] :version The version number for concurrency control.
5150
# It must match the current version of the document for the request to succeed.
5251
# @option arguments [String] :version_type The version type.

0 commit comments

Comments
 (0)