[XPACK] Regenerate X-Pack API code so RubyDocs will list all parameters

picandocodigo · picandocodigo · commit a31671dbc3a6 · 2020-07-23T14:33:23.000+01:00
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/async_search/submit.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/async_search/submit.rb
@@ -32,7 +32,6 @@ module Actions
           # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
           # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
           #   (options: AND,OR)
-
           # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
           # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
           # @option arguments [List] :stored_fields A comma-separated list of stored fields to return as part of a hit
@@ -43,14 +42,12 @@ module Actions
           # @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)
           # @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)
-
           # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
           # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
           # @option arguments [String] :q Query in the Lucene query string syntax
           # @option arguments [List] :routing A comma-separated list of specific routing values
           # @option arguments [String] :search_type Search operation type
           #   (options: query_then_fetch,dfs_query_then_fetch)
-
           # @option arguments [Number] :size Number of hits to return (default: 10)
           # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
           # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
@@ -61,7 +58,6 @@ module Actions
           # @option arguments [String] :suggest_field Specify which field to use for suggestions
           # @option arguments [String] :suggest_mode Specify suggest mode
           #   (options: missing,popular,always)
-
           # @option arguments [Number] :suggest_size How many suggestions to return in response
           # @option arguments [String] :suggest_text The source text for which the suggestions should be returned
           # @option arguments [Time] :timeout Explicit operation timeout
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_data_frame_analytics.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_data_frame_analytics.rb
@@ -26,14 +26,12 @@ module Actions
           # @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)
           # @option arguments [String] :bytes The unit in which to display byte values
           #   (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
-
           # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
           # @option arguments [List] :h Comma-separated list of column names to display
           # @option arguments [Boolean] :help Return help information
           # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
           # @option arguments [String] :time The unit in which to display time values
           #   (options: d,h,m,s,ms,micros,nanos)
-
           # @option arguments [Boolean] :v Verbose mode. Display column headers
           # @option arguments [Hash] :headers Custom HTTP headers
           #
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_datafeeds.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_datafeeds.rb
@@ -30,7 +30,6 @@ module Actions
           # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
           # @option arguments [String] :time The unit in which to display time values
           #   (options: d,h,m,s,ms,micros,nanos)
-
           # @option arguments [Boolean] :v Verbose mode. Display column headers
           # @option arguments [Hash] :headers Custom HTTP headers
           #
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_jobs.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_jobs.rb
@@ -26,14 +26,12 @@ module Actions
           # @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)
           # @option arguments [String] :bytes The unit in which to display byte values
           #   (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
-
           # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
           # @option arguments [List] :h Comma-separated list of column names to display
           # @option arguments [Boolean] :help Return help information
           # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
           # @option arguments [String] :time The unit in which to display time values
           #   (options: d,h,m,s,ms,micros,nanos)
-
           # @option arguments [Boolean] :v Verbose mode. Display column headers
           # @option arguments [Hash] :headers Custom HTTP headers
           #
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_trained_models.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_trained_models.rb
@@ -28,14 +28,12 @@ module Actions
           # @option arguments [Int] :size specifies a max number of trained models to get
           # @option arguments [String] :bytes The unit in which to display byte values
           #   (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
-
           # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
           # @option arguments [List] :h Comma-separated list of column names to display
           # @option arguments [Boolean] :help Return help information
           # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
           # @option arguments [String] :time The unit in which to display time values
           #   (options: d,h,m,s,ms,micros,nanos)
-
           # @option arguments [Boolean] :v Verbose mode. Display column headers
           # @option arguments [Hash] :headers Custom HTTP headers
           #
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/transforms.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/transforms.rb
@@ -32,7 +32,6 @@ module Actions
           # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
           # @option arguments [String] :time The unit in which to display time values
           #   (options: d,h,m,s,ms,micros,nanos)
-
           # @option arguments [Boolean] :v Verbose mode. Display column headers
           # @option arguments [Hash] :headers Custom HTTP headers
           #
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/indices/freeze.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/indices/freeze.rb
@@ -29,7 +29,6 @@ module Actions
           # @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)
           # @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)
-
           # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
           # @option arguments [Hash] :headers Custom HTTP headers
           #
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/indices/reload_search_analyzers.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/indices/reload_search_analyzers.rb
@@ -27,7 +27,6 @@ module Actions
           # @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)
           # @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)
-
           # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-reload-analyzers.html
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/indices/unfreeze.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/indices/unfreeze.rb
@@ -29,7 +29,6 @@ module Actions
           # @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)
           # @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)
-
           # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
           # @option arguments [Hash] :headers Custom HTTP headers
           #
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/find_file_structure.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/find_file_structure.rb
@@ -28,7 +28,6 @@ module Actions
           # @option arguments [String] :charset Optional parameter to specify the character set of the file
           # @option arguments [String] :format Optional parameter to specify the high level file format
           #   (options: ndjson,xml,delimited,semi_structured_text)
-
           # @option arguments [Boolean] :has_header_row Optional parameter to specify whether a delimited file includes the column names in its first row
           # @option arguments [List] :column_names Optional parameter containing a comma separated list of the column names for a delimited file
           # @option arguments [String] :delimiter Optional parameter to specify the delimiter character for a delimited file - must be a single character
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/put_datafeed.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/put_datafeed.rb
@@ -28,7 +28,6 @@ module Actions
           # @option arguments [Boolean] :ignore_throttled Ignore indices that are marked as throttled (default: true)
           # @option arguments [String] :expand_wildcards Whether source index expressions should get expanded to open or closed indices (default: open)
           #   (options: open,closed,hidden,none,all)
-
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The datafeed config (*Required*)
           #
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/update_datafeed.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/update_datafeed.rb
@@ -28,7 +28,6 @@ module Actions
           # @option arguments [Boolean] :ignore_throttled Ignore indices that are marked as throttled (default: true)
           # @option arguments [String] :expand_wildcards Whether source index expressions should get expanded to open or closed indices (default: open)
           #   (options: open,closed,hidden,none,all)
-
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The datafeed update settings (*Required*)
           #
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/searchable_snapshots/clear_cache.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/searchable_snapshots/clear_cache.rb
@@ -27,7 +27,6 @@ module Actions
           # @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)
           # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
           #   (options: open,closed,none,all)
-
           # @option arguments [List] :index A comma-separated list of index name to limit the operation
           # @option arguments [Hash] :headers Custom HTTP headers
           #
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/change_password.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/change_password.rb
@@ -25,7 +25,6 @@ module Actions
           # @option arguments [String] :username The username of the user to change the password for
           # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
           #   (options: true,false,wait_for)
-
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body the new password for the user (*Required*)
           #
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/create_api_key.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/create_api_key.rb
@@ -24,7 +24,6 @@ module Actions
           #
           # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
           #   (options: true,false,wait_for)
-
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The api key request to create an API key (*Required*)
           #
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/delete_privileges.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/delete_privileges.rb
@@ -26,7 +26,6 @@ module Actions
           # @option arguments [String] :name Privilege name
           # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
           #   (options: true,false,wait_for)
-
           # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-delete-privilege.html
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/delete_role.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/delete_role.rb
@@ -25,7 +25,6 @@ module Actions
           # @option arguments [String] :name Role name
           # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
           #   (options: true,false,wait_for)
-
           # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-delete-role.html
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/delete_role_mapping.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/delete_role_mapping.rb
@@ -25,7 +25,6 @@ module Actions
           # @option arguments [String] :name Role-mapping name
           # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
           #   (options: true,false,wait_for)
-
           # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-delete-role-mapping.html
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/delete_user.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/delete_user.rb
@@ -25,7 +25,6 @@ module Actions
           # @option arguments [String] :username username
           # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
           #   (options: true,false,wait_for)
-
           # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-delete-user.html
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/disable_user.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/disable_user.rb
@@ -25,7 +25,6 @@ module Actions
           # @option arguments [String] :username The username of the user to disable
           # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
           #   (options: true,false,wait_for)
-
           # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-disable-user.html
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/enable_user.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/enable_user.rb
@@ -25,7 +25,6 @@ module Actions
           # @option arguments [String] :username The username of the user to enable
           # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
           #   (options: true,false,wait_for)
-
           # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-enable-user.html
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/put_privileges.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/put_privileges.rb
@@ -24,7 +24,6 @@ module Actions
           #
           # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
           #   (options: true,false,wait_for)
-
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The privilege(s) to add (*Required*)
           #
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/put_role.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/put_role.rb
@@ -25,7 +25,6 @@ module Actions
           # @option arguments [String] :name Role name
           # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
           #   (options: true,false,wait_for)
-
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The role to add (*Required*)
           #
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/put_role_mapping.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/put_role_mapping.rb
@@ -25,7 +25,6 @@ module Actions
           # @option arguments [String] :name Role-mapping name
           # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
           #   (options: true,false,wait_for)
-
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The role mapping to add (*Required*)
           #
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/put_user.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/put_user.rb
@@ -25,7 +25,6 @@ module Actions
           # @option arguments [String] :username The username of the User
           # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
           #   (options: true,false,wait_for)
-
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The user to add (*Required*)
           #
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/watcher/stats.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/watcher/stats.rb
@@ -24,10 +24,8 @@ module Actions
           #
           # @option arguments [List] :metric Controls what additional stat metrics should be include in the response
           #   (options: _all,queued_watches,current_watches,pending_watches)
-
           # @option arguments [List] :metric Controls what additional stat metrics should be include in the response
           #   (options: _all,queued_watches,current_watches,pending_watches)
-
           # @option arguments [Boolean] :emit_stacktraces Emits stack traces of currently running watches
           # @option arguments [Hash] :headers Custom HTTP headers
           #

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,6 @@ module Actions`
`30`	`30`	`# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by`
`31`	`31`	`# @option arguments [String] :time The unit in which to display time values`
`32`	`32`	`# (options: d,h,m,s,ms,micros,nanos)`
`33`		`-`
`34`	`33`	`# @option arguments [Boolean] :v Verbose mode. Display column headers`
`35`	`34`	`# @option arguments [Hash] :headers Custom HTTP headers`
`36`	`35`	`#`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,6 @@ module Actions`
`32`	`32`	`# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by`
`33`	`33`	`# @option arguments [String] :time The unit in which to display time values`
`34`	`34`	`# (options: d,h,m,s,ms,micros,nanos)`
`35`		`-`
`36`	`35`	`# @option arguments [Boolean] :v Verbose mode. Display column headers`
`37`	`36`	`# @option arguments [Hash] :headers Custom HTTP headers`
`38`	`37`	`#`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,6 @@ module Actions`
`29`	`29`	# @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`	`30`	`# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.`
`31`	`31`	`# (options: open,closed,hidden,none,all)`
`32`		`-`
`33`	`32`	`# @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.`
`34`	`33`	`# @option arguments [Hash] :headers Custom HTTP headers`
`35`	`34`	`#`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,6 @@ module Actions`
`27`	`27`	# @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`	`28`	`# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.`
`29`	`29`	`# (options: open,closed,hidden,none,all)`
`30`		`-`
`31`	`30`	`# @option arguments [Hash] :headers Custom HTTP headers`
`32`	`31`	`#`
`33`	`32`	`# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-reload-analyzers.html`