Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,16 @@ module Cluster
module Actions
# Explain the shard allocations.
# Get explanations for shard allocations in the cluster.
# 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.
# For unassigned shards, it provides an explanation for why the shard is unassigned.
# 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.
# 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.
# Refer to the linked documentation for examples of how to troubleshoot allocation issues using this API.
#
# @option arguments [String] :index The name of the index that you would like an explanation for.
# @option arguments [Integer] :shard An identifier for the shard that you would like an explanation for.
# @option arguments [Boolean] :primary If true, returns an explanation for the primary shard for the specified shard ID.
# @option arguments [String] :current_node Explain a shard only if it is currently located on the specified node name or node ID.
# @option arguments [Boolean] :include_disk_info If true, returns information about disk usage and shard sizes.
# @option arguments [Boolean] :include_yes_decisions If true, returns YES decisions in explanation.
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
Expand Down
8 changes: 0 additions & 8 deletions elasticsearch-api/lib/elasticsearch/api/actions/create.rb
Original file line number Diff line number Diff line change
Expand Up @@ -77,15 +77,7 @@ module Actions
# @option arguments [String] :index The name of the data stream or index to target.
# 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.
# If the target doesn't exist and doesn’t match a data stream template, this request creates the index. (*Required*)
# @option arguments [Integer] :if_primary_term Only perform the operation if the document has this primary term.
# @option arguments [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
# @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.
# @option arguments [String] :op_type Set to `create` to only index the document if it does not already exist (put if absent).
# If a document with the specified `_id` already exists, the indexing operation will fail.
# The behavior is the same as using the `<index>/_create` endpoint.
# If a document ID is specified, this paramater defaults to `index`.
# Otherwise, it defaults to `create`.
# If the request targets a data stream, an `op_type` of `create` is required.
# @option arguments [String] :pipeline The ID of the pipeline to use to preprocess incoming documents.
# If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.
# If a final pipeline is configured, it will always run regardless of the value of this parameter.
Expand Down
5 changes: 3 additions & 2 deletions elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,12 @@ module Actions
# EQL assumes each document in a data stream or index corresponds to an event.
#
# @option arguments [String, Array] :index The name of the index to scope the operation (*Required*)
# @option arguments [Boolean] :allow_no_indices [TODO] Server default: true.
# @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.
# @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.
# @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.
# This flag has effect only if allow_partial_search_results is true.
# @option arguments [String, Array<String>] :expand_wildcards [TODO] Server default: open.
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open.
# @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.
# @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response. Server default: true.
# @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster. Server default: 5d.
# @option arguments [Boolean] :keep_on_completion If true, the search and its results are stored on the cluster.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@ module Actions
# To target all data streams and indices, omit this parameter or use `*` or `_all`.
# @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries.
# @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
# @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.
# This behavior applies even if the request targets other open indices. Server default: true.
# @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
# If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
# Supports comma-separated values, such as `open,hidden`. Server default: open.
# @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
# when they occur.
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
Expand Down
2 changes: 1 addition & 1 deletion elasticsearch-api/lib/elasticsearch/api/version.rb
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@
module Elasticsearch
module API
VERSION = '9.1.0'.freeze
ES_SPECIFICATION_COMMIT = '6dead788dfcc249ad670453d051bbe3b35555774'.freeze
ES_SPECIFICATION_COMMIT = '92bb3ad4cd1904de13a50daffbbc0a859ae39701'.freeze
end
end