Skip to content

Commit 43367a3

Browse files
committed
[API] Updates source code docs to 92bb3ad4cd1904de13a50daffbbc0a859ae39701
cluster.allocation_explain * Documents String :index parameter. The name of the index that you would like an explanation for. * Documents Integer :shard parameter. An identifier for the shard that you would like an explanation for. * Documents Boolean :primary parameter. If true, returns an explanation for the primary shard for the specified shard ID. * Documents String :current_node parameter. Explain a shard only if it is currently located on the specified node name or node ID. search * Documents Boolean parameter :ccs_minimize_roundtrips. Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution Server default: true. indices.recovery * Documents Boolean parameter :allow_no_indices. If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
1 parent d7d3818 commit 43367a3

File tree

5 files changed

+15
-11
lines changed

5 files changed

+15
-11
lines changed

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,16 @@ module Cluster
2424
module Actions
2525
# Explain the shard allocations.
2626
# Get explanations for shard allocations in the cluster.
27+
# This API accepts the current_node, index, primary and shard parameters in the request body or in query parameters, but not in both at the same time.
2728
# For unassigned shards, it provides an explanation for why the shard is unassigned.
2829
# For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node.
2930
# This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise.
3031
# Refer to the linked documentation for examples of how to troubleshoot allocation issues using this API.
3132
#
33+
# @option arguments [String] :index The name of the index that you would like an explanation for.
34+
# @option arguments [Integer] :shard An identifier for the shard that you would like an explanation for.
35+
# @option arguments [Boolean] :primary If true, returns an explanation for the primary shard for the specified shard ID.
36+
# @option arguments [String] :current_node Explain a shard only if it is currently located on the specified node name or node ID.
3237
# @option arguments [Boolean] :include_disk_info If true, returns information about disk usage and shard sizes.
3338
# @option arguments [Boolean] :include_yes_decisions If true, returns YES decisions in explanation.
3439
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.

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/indices/recovery.rb

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,12 @@ module Actions
4545
# To target all data streams and indices, omit this parameter or use `*` or `_all`.
4646
# @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries.
4747
# @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
48+
# @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
49+
# This behavior applies even if the request targets other open indices. Server default: true.
50+
# @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
51+
# If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
52+
# Supports comma-separated values, such as `open,hidden`. Server default: open.
53+
# @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
4854
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
4955
# when they occur.
5056
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response

elasticsearch-api/lib/elasticsearch/api/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@
1818
module Elasticsearch
1919
module API
2020
VERSION = '9.1.0'.freeze
21-
ES_SPECIFICATION_COMMIT = '6dead788dfcc249ad670453d051bbe3b35555774'.freeze
21+
ES_SPECIFICATION_COMMIT = '92bb3ad4cd1904de13a50daffbbc0a859ae39701'.freeze
2222
end
2323
end

0 commit comments

Comments
 (0)