Skip to content

Commit ce9471c

Browse files
committed
[XPACK] Regenerate code with doc improvements
1 parent ff90a4c commit ce9471c

31 files changed

+38
-71
lines changed

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/async_search/submit.rb

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ module Actions
3030
# @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to true
3131
# @option arguments [String] :analyzer The analyzer to use for the query string
3232
# @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
33-
# @option arguments [String] :default_operator The default operator for query string query (AND or OR)
34-
# (options: AND,OR)
33+
# @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
3534
# @option arguments [String] :df The field to use as default where no field prefix is given in the query string
3635
# @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
3736
# @option arguments [List] :stored_fields A comma-separated list of stored fields to return as part of a hit
@@ -40,14 +39,12 @@ module Actions
4039
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
4140
# @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
4241
# @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)
43-
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
44-
# (options: open,closed,hidden,none,all)
42+
# @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)
4543
# @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
4644
# @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
4745
# @option arguments [String] :q Query in the Lucene query string syntax
4846
# @option arguments [List] :routing A comma-separated list of specific routing values
49-
# @option arguments [String] :search_type Search operation type
50-
# (options: query_then_fetch,dfs_query_then_fetch)
47+
# @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
5148
# @option arguments [Number] :size Number of hits to return (default: 10)
5249
# @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
5350
# @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
@@ -56,8 +53,7 @@ module Actions
5653
# @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
5754
# @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
5855
# @option arguments [String] :suggest_field Specify which field to use for suggestions
59-
# @option arguments [String] :suggest_mode Specify suggest mode
60-
# (options: missing,popular,always)
56+
# @option arguments [String] :suggest_mode Specify suggest mode (options: missing, popular, always)
6157
# @option arguments [Number] :suggest_size How many suggestions to return in response
6258
# @option arguments [String] :suggest_text The source text for which the suggestions should be returned
6359
# @option arguments [Time] :timeout Explicit operation timeout

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_data_frame_analytics.rb

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,12 @@ module Actions
2424
#
2525
# @option arguments [String] :id The ID of the data frame analytics to fetch
2626
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)
27-
# @option arguments [String] :bytes The unit in which to display byte values
28-
# (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
27+
# @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
2928
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
3029
# @option arguments [List] :h Comma-separated list of column names to display
3130
# @option arguments [Boolean] :help Return help information
3231
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
33-
# @option arguments [String] :time The unit in which to display time values
34-
# (options: d,h,m,s,ms,micros,nanos)
32+
# @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
3533
# @option arguments [Boolean] :v Verbose mode. Display column headers
3634
# @option arguments [Hash] :headers Custom HTTP headers
3735
#

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_datafeeds.rb

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ module Actions
2828
# @option arguments [List] :h Comma-separated list of column names to display
2929
# @option arguments [Boolean] :help Return help information
3030
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
31-
# @option arguments [String] :time The unit in which to display time values
32-
# (options: d,h,m,s,ms,micros,nanos)
31+
# @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
3332
# @option arguments [Boolean] :v Verbose mode. Display column headers
3433
# @option arguments [Hash] :headers Custom HTTP headers
3534
#

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_jobs.rb

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,12 @@ module Actions
2424
#
2525
# @option arguments [String] :job_id The ID of the jobs stats to fetch
2626
# @option arguments [Boolean] :allow_no_jobs Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
27-
# @option arguments [String] :bytes The unit in which to display byte values
28-
# (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
27+
# @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
2928
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
3029
# @option arguments [List] :h Comma-separated list of column names to display
3130
# @option arguments [Boolean] :help Return help information
3231
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
33-
# @option arguments [String] :time The unit in which to display time values
34-
# (options: d,h,m,s,ms,micros,nanos)
32+
# @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
3533
# @option arguments [Boolean] :v Verbose mode. Display column headers
3634
# @option arguments [Hash] :headers Custom HTTP headers
3735
#

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_trained_models.rb

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,12 @@ module Actions
2626
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)
2727
# @option arguments [Int] :from skips a number of trained models
2828
# @option arguments [Int] :size specifies a max number of trained models to get
29-
# @option arguments [String] :bytes The unit in which to display byte values
30-
# (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
29+
# @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
3130
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
3231
# @option arguments [List] :h Comma-separated list of column names to display
3332
# @option arguments [Boolean] :help Return help information
3433
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
35-
# @option arguments [String] :time The unit in which to display time values
36-
# (options: d,h,m,s,ms,micros,nanos)
34+
# @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
3735
# @option arguments [Boolean] :v Verbose mode. Display column headers
3836
# @option arguments [Hash] :headers Custom HTTP headers
3937
#

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/transforms.rb

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ module Actions
3030
# @option arguments [List] :h Comma-separated list of column names to display
3131
# @option arguments [Boolean] :help Return help information
3232
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
33-
# @option arguments [String] :time The unit in which to display time values
34-
# (options: d,h,m,s,ms,micros,nanos)
33+
# @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
3534
# @option arguments [Boolean] :v Verbose mode. Display column headers
3635
# @option arguments [Hash] :headers Custom HTTP headers
3736
#

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/update_transform.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ module Actions
2626
# as-is with no warranties. Beta features are not subject to the support
2727
# SLA of official GA features.
2828
#
29-
# @option arguments [String] :transform_id The id of the transform. (*Required*)
29+
# @option arguments [String] :transform_id The id of the transform. (*Required*)
3030
# @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false.
3131
# @option arguments [Hash] :headers Custom HTTP headers
3232
# @option arguments [Hash] :body The update transform definition (*Required*)

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/graph/explore.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ module Actions
2323
# Explore extracted and summarized information about the documents and terms in an index.
2424
#
2525
# @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
26-
# @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types *Deprecated*
26+
# @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types *Deprecated*
2727
# @option arguments [String] :routing Specific routing value
2828
# @option arguments [Time] :timeout Explicit operation timeout
2929
# @option arguments [Hash] :headers Custom HTTP headers

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/indices/freeze.rb

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ module Actions
2727
# @option arguments [Time] :master_timeout Specify timeout for connection to master
2828
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
2929
# @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)
30-
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
31-
# (options: open,closed,hidden,none,all)
30+
# @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)
3231
# @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
3332
# @option arguments [Hash] :headers Custom HTTP headers
3433
#

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/indices/reload_search_analyzers.rb

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ module Actions
2525
# @option arguments [List] :index A comma-separated list of index names to reload analyzers for
2626
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
2727
# @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)
28-
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
29-
# (options: open,closed,hidden,none,all)
28+
# @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)
3029
# @option arguments [Hash] :headers Custom HTTP headers
3130
#
3231
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-reload-analyzers.html

0 commit comments

Comments
 (0)