Skip to content

Commit ccafc37

Browse files
committed
[API] Updates source code documentation
create: * Documents Boolean parameter :require_alias. When true, requires destination to be an alias. Default is false * Documents Boolean parameter :require_data_stream. When true, requires destination to be a data stream (existing or to be created). Default is false eql.search: * Documents Boolean parameter :ccs_minimize_roundtrips. Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution * Documents Boolean parameter :ignore_unavailable. Whether specified concrete indices should be ignored when unavailable (missing or closed) * Documents Boolean parameter :allow_no_indices. Whether to ignore if a wildcard indices expression resolves into no concrete indices * Documents String parameter :expand_wildcards. Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) indices.recovery: * Documents Boolean parameter :ignore_unavailable. Whether specified concrete indices should be ignored when unavailable (missing or closed) * Documents Boolean parameter :allow_no_indices. Whether to ignore if a wildcard indices expression resolves into no concrete indices * Documents String parameter :expand_wildcards. Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) msearch: Documents Boolean parameter :ignore_unavailable. Whether specified concrete indices should be ignored when unavailable (missing or closed) Documents Boolean parameter :ignore_throttled. Whether specified concrete, expanded or aliased indices should be ignored when throttled *Deprecated* Documents Boolean parameter :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) Documents String parameter :expand_wildcards. Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) Documents List parameter :routing. A comma-separated list of specific routing values Documents Boolean parameter :include_named_queries_score Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) reindex: * Documents Boolean argument :require_alias. When true, requires destination to be an alias. snapshot.repository: * Documents Number parameter :register_operation_count. The minimum number of linearizable register operations to perform in total. Defaults to 10.
1 parent 7dff715 commit ccafc37

File tree

6 files changed

+17
-0
lines changed

6 files changed

+17
-0
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ module Actions
3535
# @option arguments [String] :version_type Specific version type (options: internal, external, external_gte)
3636
# @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
3737
# @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. Defaults to true.
38+
# @option arguments [Boolean] :require_alias When true, requires destination to be an alias. Default is false
39+
# @option arguments [Boolean] :require_data_stream When true, requires destination to be a data stream (existing or to be created). Default is false
3840
# @option arguments [Hash] :headers Custom HTTP headers
3941
# @option arguments [Hash] :body The document (*Required*)
4042
#

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ module Actions
3030
# @option arguments [Time] :keep_alive Update the time interval in which the results (partial or final) for this search will be available
3131
# @option arguments [Boolean] :allow_partial_search_results Control whether the query should keep running in case of shard failures, and return partial results
3232
# @option arguments [Boolean] :allow_partial_sequence_results Control whether a sequence query should return partial results or no results at all in case of shard failures. This option has effect only if [allow_partial_search_results] is true.
33+
# @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
34+
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
35+
# @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)
36+
# @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)
3337
# @option arguments [Hash] :headers Custom HTTP headers
3438
# @option arguments [Hash] :body Eql request body. Use the `query` to limit the query scope. (*Required*)
3539
#

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ module Actions
2727
# @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
2828
# @option arguments [Boolean] :detailed Whether to display detailed information about shard recovery
2929
# @option arguments [Boolean] :active_only Display only those recoveries that are currently on-going
30+
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
31+
# @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)
32+
# @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)
3033
# @option arguments [Hash] :headers Custom HTTP headers
3134
#
3235
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/indices-recovery.html

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ module Actions
3131
# @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
3232
# @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
3333
# @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
34+
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
35+
# @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled *Deprecated*
36+
# @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)
37+
# @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)
38+
# @option arguments [List] :routing A comma-separated list of specific routing values
39+
# @option arguments [Boolean] :include_named_queries_score Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)
3440
# @option arguments [Hash] :headers Custom HTTP headers
3541
# @option arguments [Hash] :body The request definitions (metadata-search request definition pairs), separated by newlines (*Required*)
3642
#

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ module Actions
3333
# @option arguments [Time] :scroll Control how long to keep the search context alive
3434
# @option arguments [Number|string] :slices The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.
3535
# @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)
36+
# @option arguments [Boolean] :require_alias When true, requires destination to be an alias.
3637
# @option arguments [Hash] :headers Custom HTTP headers
3738
# @option arguments [Hash] :body The search definition using the Query DSL and the prototype for the index request. (*Required*)
3839
#

elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ module Actions
2727
# @option arguments [String] :repository A repository name
2828
# @option arguments [Number] :blob_count Number of blobs to create during the test. Defaults to 100.
2929
# @option arguments [Number] :concurrency Number of operations to run concurrently during the test. Defaults to 10.
30+
# @option arguments [Number] :register_operation_count The minimum number of linearizable register operations to perform in total. Defaults to 10.
3031
# @option arguments [Number] :read_node_count Number of nodes on which to read a blob after writing. Defaults to 10.
3132
# @option arguments [Number] :early_read_node_count Number of nodes on which to perform an early read on a blob, i.e. before writing has completed. Early reads are rare actions so the 'rare_action_probability' parameter is also relevant. Defaults to 2.
3233
# @option arguments [Number] :seed Seed for the random number generator used to create the test workload. Defaults to a random value.

0 commit comments

Comments
 (0)