diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb index 111d9704c3..8f181c75eb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb @@ -23,7 +23,6 @@ module API module AsyncSearch module Actions # Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. - # # @option arguments [String] :id The async search ID # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb index dbc533b10a..76024d6a19 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb @@ -23,7 +23,6 @@ module API module AsyncSearch module Actions # Retrieves the results of a previously submitted async search request given its ID. - # # @option arguments [String] :id The async search ID # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response # @option arguments [Time] :keep_alive Specify the time interval in which the results (partial or final) for this search will be available diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb index 6540aab971..b1ac016c94 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb @@ -23,7 +23,6 @@ module API module AsyncSearch module Actions # Retrieves the status of a previously submitted async search request given its ID. - # # @option arguments [String] :id The async search ID # @option arguments [Time] :keep_alive Specify the time interval in which the results (partial or final) for this search will be available # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb index afb1fcac18..ef8ce28f98 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb @@ -23,7 +23,6 @@ module API module AsyncSearch module Actions # Executes a search request asynchronously. - # # @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 # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response # @option arguments [Boolean] :keep_on_completion Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/delete_autoscaling_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/delete_autoscaling_policy.rb index 5898dae9cc..b057e3b11e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/delete_autoscaling_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/delete_autoscaling_policy.rb @@ -23,7 +23,6 @@ module API module Autoscaling module Actions # Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. - # # @option arguments [String] :name the name of the autoscaling policy # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_policy.rb index 445784437c..3f28465fe9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_policy.rb @@ -23,7 +23,6 @@ module API module Autoscaling module Actions # Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. - # # @option arguments [String] :name the name of the autoscaling policy # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/put_autoscaling_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/put_autoscaling_policy.rb index debaa9a299..f297cd08f0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/put_autoscaling_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/put_autoscaling_policy.rb @@ -23,7 +23,6 @@ module API module Autoscaling module Actions # Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. - # # @option arguments [String] :name the name of the autoscaling policy # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body the specification of the autoscaling policy (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb b/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb index c699ddeb8d..3b63a9edc2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Allows to perform multiple index/update/delete operations in a single request. - # # @option arguments [String] :index Default index for items which don't provide one # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) # @option arguments [String] :refresh If `true` 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` (the default) then do nothing with refreshes. (options: true, false, wait_for) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb index 5adb4e4187..134de7366b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Shows information about currently configured aliases to indices including filter and routing infos. - # # @option arguments [List] :name A comma-separated list of alias names to return # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb index fa8e35a90e..fccabcb91b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. - # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb index dba8cee89a..6e6c99cfa5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns information about existing component_templates templates. - # # @option arguments [String] :name A pattern that returned component template names must match # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb index 9e901c97c8..f0ea3b00ae 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Provides quick access to the document count of the entire cluster, or individual indices. - # # @option arguments [List] :index A comma-separated list of index names to limit the returned information # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb index 21c49ffec3..3193ea0790 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Shows how much heap memory is currently being used by fielddata on every data node in the cluster. - # # @option arguments [List] :fields A comma-separated list of fields to return the fielddata size # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb index dae0d2eb13..db4af2fbcf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns a concise representation of the cluster health. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb index 85e290a974..db31e4d41a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns help for the Cat APIs. - # # @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 [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb index 9f5488ec77..75f1fadb02 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns information about indices: number of primaries and replicas, document counts, disk size, ... - # # @option arguments [List] :index A comma-separated list of index names to limit the returned information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb index 7adf501baa..809b09590a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns information about the master node. - # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb index 8f91c3d6dd..ec81a0a9d2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Gets configuration and usage information about data frame analytics jobs. - # # @option arguments [String] :id The ID of the data frame analytics to fetch # @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) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb index a7d96fbfba..05bf374b33 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Gets configuration and usage information about datafeeds. - # # @option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb index 8ff9745236..aa82e257dc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Gets configuration and usage information about anomaly detection jobs. - # # @option arguments [String] :job_id The ID of the jobs stats to fetch # @option arguments [Boolean] :allow_no_match 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) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb index d59663f334..55d27f8569 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Gets configuration and usage information about inference trained models. - # # @option arguments [String] :model_id The ID of the trained models stats to fetch # @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) # @option arguments [Integer] :from skips a number of trained models diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb index e63b170d7c..a38691156b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns information about custom node attributes. - # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb index 90f9c60e29..f1885f21c5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns basic statistics about performance of cluster nodes. - # # @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 [Boolean] :full_id Return the full node ID instead of the shortened version (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb index 8dbbd805b4..482e9084c5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns a concise representation of the cluster pending tasks. - # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb index ed82f5fbd6..56ba41b8d9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns information about installed plugins across nodes node. - # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb index 4d37f93ad2..6894f532dc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns information about index shard recoveries, both on-going completed. - # # @option arguments [List] :index Comma-separated list or wildcard expression of index names to limit the returned information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb index 6886996ca5..237a247da7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns information about snapshot repositories registered in the cluster. - # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb index 9ea1a35284..a17d63d8fc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Provides low-level information about the segments in the shards of an index. - # # @option arguments [List] :index A comma-separated list of index names to limit the returned information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb index baf4b5a1ea..6f19f89c7e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Provides a detailed view of shard allocation on nodes. - # # @option arguments [List] :index A comma-separated list of index names to limit the returned information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb index 5ef7f28ee6..e804b124c5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns all snapshots in a specific repository. - # # @option arguments [List] :repository Name of repository from which to fetch the snapshot information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :ignore_unavailable Set to true to ignore unavailable snapshots diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb index eb2b25f8db..02e8dd3727 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns information about existing templates. - # # @option arguments [String] :name A pattern that returned template names must match # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb index d0dd7f0e5f..b668020632 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb @@ -24,7 +24,6 @@ module Cat module Actions # Returns cluster-wide thread pool statistics per node. # By default the active, queue and rejected statistics are returned for all thread pools. - # # @option arguments [List] :thread_pool_patterns A comma-separated list of regular-expressions to filter the thread pools in the output # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb index 903bcf706f..6130a3f421 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Gets configuration and usage information about transforms. - # # @option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms # @option arguments [Integer] :from skips a number of transform configs, defaults to 0 # @option arguments [Integer] :size specifies a max number of transforms to get, defaults to 100 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb b/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb index d907f8b679..df043e6146 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Explicitly clears the search context for a scroll. - # # @option arguments [List] :scroll_id A comma-separated list of scroll IDs to clear *Deprecated* # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb index 96d6d0e560..f4cf2b5c19 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Provides explanations for shard allocations in the cluster. - # # @option arguments [Boolean] :include_yes_decisions Return 'YES' decisions in explanation (default: false) # @option arguments [Boolean] :include_disk_info Return information about disk usage and shard sizes (default: false) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_component_template.rb index 1c4c1ce42f..76aa88ecc1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_component_template.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Deletes a component template - # # @option arguments [String] :name The name of the template # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb index 93d20d805f..a4f7f7c428 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Clears cluster voting config exclusions. - # # @option arguments [Boolean] :wait_for_removal Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. # @option arguments [Time] :master_timeout Timeout for submitting request to master # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb index f601f3b30a..17952c37c1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Returns information about whether a particular component template exist - # # @option arguments [String] :name The name of the template # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb index c075917007..346d6c5eee 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Returns one or more component templates - # # @option arguments [List] :name The comma separated names of the component templates # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb index dfda48b753..d36eaca9f0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Returns cluster settings. - # # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb index 5fbf8e6725..abfdc62228 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Returns basic information about the health of the cluster. - # # @option arguments [List] :index Limit the information returned to a specific index # @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] :level Specify the level of detail for returned information (options: cluster, indices, shards) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb index b344f97a4b..d75c2b1c40 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Returns different information about the cluster. - # # @option arguments [List] :target Limit the information returned to the specified target. (options: _all, http, ingest, thread_pool, script) # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb index c85e438d89..6e716b87d4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb @@ -24,7 +24,6 @@ module Cluster module Actions # Returns a list of any cluster-level changes (e.g. create index, update mapping, # allocate or fail shard) which have not yet been executed. - # # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb index 87e750a868..8165536192 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Updates the cluster voting config exclusions by node ids or node names. - # # @option arguments [String] :node_ids A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_names. # @option arguments [String] :node_names A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_ids. # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb index d311b49c17..aed581686a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Creates or updates a component template - # # @option arguments [String] :name The name of the template # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb index cbb6894f17..46c636e05a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Updates the cluster settings. - # # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb index dcfb54215a..f7b1df1e88 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Allows to manually change the allocation of individual shards in the cluster. - # # @option arguments [Boolean] :dry_run Simulate the operation only and return the resulting state # @option arguments [Boolean] :explain Return an explanation of why the commands can or cannot be executed # @option arguments [Boolean] :retry_failed Retries allocation of shards that are blocked due to too many subsequent allocation failures diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb index bf8988b5f9..0b4b2a5788 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Returns a comprehensive information about the state of the cluster. - # # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, blocks, metadata, nodes, routing_table, routing_nodes, master_node, version) # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb index 58a0804ae9..83d0919b1b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Returns high-level overview of cluster statistics. - # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/count.rb b/elasticsearch-api/lib/elasticsearch/api/actions/count.rb index 35c4acd79b..00f7dabb63 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/count.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/count.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns number of documents matching a query. - # # @option arguments [List] :index A comma-separated list of indices to restrict the results # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/create.rb index ab21420431..e021e3efdc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/create.rb @@ -24,7 +24,6 @@ module Actions # Creates a new document in the index. # # Returns a 409 response when a document with a same ID already exists in the index. - # # @option arguments [String] :id Document ID # @option arguments [String] :index The name of the index # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb index 8cc2cca21e..40860f478f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Deletes auto-follow patterns. - # # @option arguments [String] :name The name of the auto follow pattern. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb index 88aacfce4a..67c33e636d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Creates a new follower index configured to follow the referenced leader index. - # # @option arguments [String] :index The name of the follower index # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before returning. Defaults to 0. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb index 7523b4f964..55656f8d0b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Retrieves information about all follower indices, including parameters and status for each follower index - # # @option arguments [List] :index A comma-separated list of index patterns; use `_all` to perform the operation on all indices # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb index 3a9f84acc7..d71ba2ca95 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. - # # @option arguments [List] :index A comma-separated list of index patterns; use `_all` to perform the operation on all indices # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb index 0e05e94421..03a1d7f317 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Removes the follower retention leases from the leader. - # # @option arguments [String] :index the name of the leader index for which specified follower retention leases should be removed # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb index 949b8ddd8b..7cc35fcdae 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. - # # @option arguments [String] :name The name of the auto follow pattern. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb index 071fe8b9e7..ae30f68c08 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Pauses an auto-follow pattern - # # @option arguments [String] :name The name of the auto follow pattern that should pause discovering new indices to follow. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb index 206ae13ccf..824b386423 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Pauses a follower index. The follower index will not fetch any additional operations from the leader index. - # # @option arguments [String] :index The name of the follower index that should pause following its leader index. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb index b43e7d759a..6632e5ab54 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. - # # @option arguments [String] :name The name of the auto follow pattern. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb index 0d02fa3c30..d840499641 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Resumes an auto-follow pattern that has been paused - # # @option arguments [String] :name The name of the auto follow pattern to resume discovering new indices to follow. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb index 7f942638a9..069c68d125 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Resumes a follower index that has been paused - # # @option arguments [String] :index The name of the follow index to resume following. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb index 775cf4f8b4..4fe1826206 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Gets all stats related to cross-cluster replication. - # # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb index 3934d63c2f..f23d785c97 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. - # # @option arguments [String] :index The name of the follower index that should be turned into a regular index. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb index 609a9db03e..d50d3a94a6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb @@ -23,7 +23,6 @@ module API module DanglingIndices module Actions # Deletes the specified dangling index - # # @option arguments [String] :index_uuid The UUID of the dangling index # @option arguments [Boolean] :accept_data_loss Must be set to true in order to delete the dangling index # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb index 9b1a9d698c..18c5dcb5d0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb @@ -23,7 +23,6 @@ module API module DanglingIndices module Actions # Imports the specified dangling index - # # @option arguments [String] :index_uuid The UUID of the dangling index # @option arguments [Boolean] :accept_data_loss Must be set to true in order to import the dangling index # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb index 2c50e19e74..4abc87a03c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Removes a document from the index. - # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb index 98df0dfb17..d54cafe435 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Deletes documents matching the provided query. - # # @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 # @option arguments [String] :analyzer The analyzer to use for the query string # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb index c003e649ad..b1b92098d2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Changes the number of requests per second for a particular Delete By Query operation. - # # @option arguments [String] :task_id The task id to rethrottle # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb index d7b8e788f1..84568c813c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Deletes a script. - # # @option arguments [String] :id Script ID # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb index 344d4a16c7..3902e07f49 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb @@ -23,7 +23,6 @@ module API module Enrich module Actions # Deletes an existing enrich policy and its enrich index. - # # @option arguments [String] :name The name of the enrich policy # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb index 2362b7527f..fb1103b5f7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb @@ -23,7 +23,6 @@ module API module Enrich module Actions # Creates the enrich index for an existing enrich policy. - # # @option arguments [String] :name The name of the enrich policy # @option arguments [Boolean] :wait_for_completion Should the request should block until the execution is complete. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb index b9c773ee21..b21cc13467 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb @@ -23,7 +23,6 @@ module API module Enrich module Actions # Gets information about an enrich policy. - # # @option arguments [List] :name A comma-separated list of enrich policy names # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb index 2fd1bf3a93..370d8220e9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb @@ -23,7 +23,6 @@ module API module Enrich module Actions # Creates a new enrich policy. - # # @option arguments [String] :name The name of the enrich policy # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The enrich policy to register (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb index daae69fb27..1aba8cb941 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb @@ -23,7 +23,6 @@ module API module Eql module Actions # Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. - # # @option arguments [String] :id The async search ID # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb index dd50ad4df8..3a506f3bcd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb @@ -23,7 +23,6 @@ module API module Eql module Actions # Returns async results from previously executed Event Query Language (EQL) search - # # @option arguments [String] :id The async search ID # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response # @option arguments [Time] :keep_alive Update the time interval in which the results (partial or final) for this search will be available diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb index 3af1dd80c9..5623af077b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb @@ -23,7 +23,6 @@ module API module Eql module Actions # Returns the status of a previously submitted async or stored Event Query Language (EQL) search - # # @option arguments [String] :id The async search ID # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb index 97606bc052..bf1c8e2166 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb @@ -23,7 +23,6 @@ module API module Eql module Actions # Returns results matching a query expressed in Event Query Language (EQL) - # # @option arguments [String] :index The name of the index to scope the operation # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response # @option arguments [Boolean] :keep_on_completion Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb index b044ce43a1..ed84382596 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb @@ -23,7 +23,6 @@ module API module Esql module Actions # Executes an ESQL request asynchronously - # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the csv format. # @option arguments [Boolean] :drop_null_columns Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb index 2548f12f9a..a5f7d5c14f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb @@ -23,7 +23,6 @@ module API module Esql module Actions # Retrieves the results of a previously submitted async query request given its ID. - # # @option arguments [String] :id The async query ID # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response # @option arguments [Time] :keep_alive Specify the time interval in which the results (partial or final) for this search will be available diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb index 1d65761c69..378fd5a1f9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb @@ -23,7 +23,6 @@ module API module Esql module Actions # Executes an ESQL request - # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the csv format. # @option arguments [Boolean] :drop_null_columns Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb b/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb index c81a07cf16..3daf5e43a5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns information about whether a document exists in an index. - # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb b/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb index 542f2c3059..f03e4dccee 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns information about whether a document source exists in an index. - # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb b/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb index 3616a78776..0fa4cfda7c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns information about why a specific matches (or doesn't match) a query. - # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index # @option arguments [Boolean] :analyze_wildcard Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb b/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb index d63e61bf92..d5eb2e6b55 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb @@ -23,7 +23,6 @@ module API module Features module Actions # Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot - # # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb b/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb index 1ed57dcdd8..3f77b966e3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns the information about the capabilities of fields among multiple indices. - # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [List] :fields A comma-separated list of field names # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb index a4fcdf7ee7..1f37f4be88 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb @@ -23,7 +23,6 @@ module API module Fleet module Actions # Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project. - # # @option arguments [String] :index The name of the index. # @option arguments [Boolean] :wait_for_advance Whether to wait for the global checkpoint to advance past the specified current checkpoints # @option arguments [Boolean] :wait_for_index Whether to wait for the target index to exist and all primary shards be active diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get.rb index 9266dd4d1c..305e6731a1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns a document. - # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index # @option arguments [Boolean] :force_synthetic_source Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb index 5f933d8527..ef5cfd60b3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns a script. - # # @option arguments [String] :id Script ID # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb index bc3295c017..02724314c3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns the source of a document. - # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb b/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb index 0e772315ec..937a8936c2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb @@ -23,7 +23,6 @@ module API module Graph module Actions # Explore extracted and summarized information about the documents and terms in an index. - # # @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 # @option arguments [String] :routing Specific routing value # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb b/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb index 36462cae75..908b2de751 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns the health of the cluster. - # # @option arguments [String] :feature A feature of the cluster, as returned by the top-level health API # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Boolean] :verbose Opt in for more information about the health of the system diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index.rb index d0a8af5adf..ef2c22046a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Creates or updates a document in an index. - # # @option arguments [String] :id Document ID # @option arguments [String] :index The name of the index # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb index d50a3c1e83..3569c69be4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb @@ -23,7 +23,6 @@ module API module IndexLifecycleManagement module Actions # Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted. - # # @option arguments [String] :policy The name of the index lifecycle policy # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb index db87878a6d..9dc6b30e68 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb @@ -23,7 +23,6 @@ module API module IndexLifecycleManagement module Actions # Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step. - # # @option arguments [String] :index The name of the index to explain # @option arguments [Boolean] :only_managed filters the indices included in the response to ones managed by ILM # @option arguments [Boolean] :only_errors filters the indices included in the response to ones in an ILM error state, implies only_managed diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb index 85fb5ad8a0..5c356029e0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb @@ -23,7 +23,6 @@ module API module IndexLifecycleManagement module Actions # Returns the specified policy definition. Includes the policy version and last modified date. - # # @option arguments [String] :policy The name of the index lifecycle policy # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb index 8a638ca03c..e81275d711 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb @@ -23,7 +23,6 @@ module API module IndexLifecycleManagement module Actions # Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing - # # @option arguments [Boolean] :dry_run If set to true it will simulate the migration, providing a way to retrieve the ILM policies and indices that need to be migrated. The default is false # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Optionally specify a legacy index template name to delete and optionally specify a node attribute name used for index shard routing (defaults to "data") diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb index c08d17693c..6323d4997e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb @@ -23,7 +23,6 @@ module API module IndexLifecycleManagement module Actions # Manually moves an index into the specified step and executes that step. - # # @option arguments [String] :index The name of the index whose lifecycle step is to change # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The new lifecycle step to move to diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb index 72fb95d15a..2ed2ee9177 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb @@ -23,7 +23,6 @@ module API module IndexLifecycleManagement module Actions # Creates a lifecycle policy - # # @option arguments [String] :policy The name of the index lifecycle policy # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The lifecycle policy definition to register diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb index d15b84f19f..7fca74eb6d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb @@ -23,7 +23,6 @@ module API module IndexLifecycleManagement module Actions # Removes the assigned lifecycle policy and stops managing the specified index - # # @option arguments [String] :index The name of the index to remove policy on # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb index dc9104cb57..5e0b3661f3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb @@ -23,7 +23,6 @@ module API module IndexLifecycleManagement module Actions # Retries executing the policy for an index that is in the ERROR step. - # # @option arguments [String] :index The name of the indices (comma-separated) whose failed lifecycle step is to be retry # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb index a7daced341..672487447a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Adds a block to an index. - # # @option arguments [List] :index A comma separated list of indices to add a block to # @option arguments [String] :block The block to add (one of read, write, read_only or metadata) # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb index 3cc740a9c0..7b697648d0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Performs the analysis process on a text and return the tokens breakdown of the text. - # # @option arguments [String] :index The name of the index to scope the operation # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Define analyzer/tokenizer parameters and the text on which the analysis should be performed diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb index 349754a0b6..8e3c74ffbe 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Clears all or specific caches for one or more indices. - # # @option arguments [List] :index A comma-separated list of index name to limit the operation # @option arguments [Boolean] :fielddata Clear field data # @option arguments [List] :fields A comma-separated list of fields to clear when using the `fielddata` parameter (default: all) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb index 0ac5579a2b..62514cbfde 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Clones an index - # # @option arguments [String] :index The name of the source index to clone # @option arguments [String] :target The name of the target index to clone into # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb index d40b0efd2d..ba884a9ab8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Closes an index. - # # @option arguments [List] :index A comma separated list of indices to close # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb index a3fc707111..a16cf26277 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Creates an index with optional settings and mappings. - # # @option arguments [String] :index The name of the index # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for before the operation returns. # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_data_stream.rb index 2e8c7da44d..44410303fe 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_data_stream.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Creates a data stream - # # @option arguments [String] :name The name of the data stream # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb index 5c681e9d20..c3fb3c0847 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Provides statistics on operations happening in a data stream. - # # @option arguments [List] :name A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb index 0474b93421..40e88105f7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Deletes an index. - # # @option arguments [List] :index A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb index 2215f7d164..b6cf56143b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Deletes an alias. - # # @option arguments [List] :index A comma-separated list of index names (supports wildcards); use `_all` for all indices # @option arguments [List] :name A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. # @option arguments [Time] :timeout Explicit timestamp for the document diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream.rb index 10cec9a452..0e77e98e8b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Deletes a data stream. - # # @option arguments [List] :name A comma-separated list of data streams to delete; use `*` to delete all data streams # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb index dffb845109..be1a512929 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Deletes an index template. - # # @option arguments [String] :name The name of the template # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb index 084b280341..ac20e7d19c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Deletes an index template. - # # @option arguments [String] :name The name of the template # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb index 9b70b945ee..4377f11f82 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns information about whether a particular index exists. - # # @option arguments [List] :index A comma-separated list of index names # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb index 08943d6d7e..94041ade9e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns information about whether a particular alias exists. - # # @option arguments [List] :name A comma-separated list of alias names to return # @option arguments [List] :index A comma-separated list of index names to filter aliases # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb index 1c69816438..0e8d2068cc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns information about whether a particular index template exists. - # # @option arguments [String] :name The name of the template # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb index 40407a2036..715533fb8f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns information about whether a particular index template exists. - # # @option arguments [List] :name The comma separated names of the index templates # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb index 89d1657c04..57fb7589f5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Performs the flush operation on one or more indices. - # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string for all indices # @option arguments [Boolean] :force Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal) # @option arguments [Boolean] :wait_if_ongoing If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb index c31d653323..5aaca07cdc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Performs the force merge operation on one or more indices. - # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :flush Specify whether the index should be flushed after performing the operation (default: true) # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb index 5ddd96c93f..9dbbbd7283 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns information about one or more indices. - # # @option arguments [List] :index A comma-separated list of index names # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb index e5888ae20e..e09ede0b52 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns an alias. - # # @option arguments [List] :name A comma-separated list of alias names to return # @option arguments [List] :index A comma-separated list of index names to filter aliases # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb index 1c44fbef22..664c51316b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns data streams. - # # @option arguments [List] :name A comma-separated list of data streams to get; use `*` to get all data streams # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) # @option arguments [Boolean] :include_defaults Return all relevant default configurations for the data stream (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb index 05629d313c..796c068130 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns mapping for one or more fields. - # # @option arguments [List] :fields A comma-separated list of fields # @option arguments [List] :index A comma-separated list of index names # @option arguments [Boolean] :include_defaults Whether the default mapping values should be returned as well diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb index c94e0182d4..870f75268f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns an index template. - # # @option arguments [String] :name A pattern that returned template names must match # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb index 9d31109088..6a432697ff 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns mappings for one or more indices. - # # @option arguments [List] :index A comma-separated list of index names # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @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) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb index 20eae8dc58..68baef797b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns settings for one or more indices. - # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [List] :name The name of the settings that should be included # @option arguments [Time] :master_timeout Specify timeout for connection to master diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb index 6cc16f0187..b6280008fd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns an index template. - # # @option arguments [List] :name The comma separated names of the index templates # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb index cd3299432e..1fd36d96f4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Migrates an alias to a data stream - # # @option arguments [String] :name The name of the alias to migrate # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb index 2af77d75d4..a1b4da9812 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Opens an index. - # # @option arguments [List] :index A comma separated list of indices to open # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/promote_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/promote_data_stream.rb index b0926a189b..37ce5bce10 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/promote_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/promote_data_stream.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Promotes a data stream from a replicated data stream managed by CCR to a regular data stream - # # @option arguments [String] :name The name of the data stream # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb index 6b37ba9c35..d00dec274f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Creates or updates an alias. - # # @option arguments [List] :index A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. # @option arguments [String] :name The name of the alias to be created or updated # @option arguments [Time] :timeout Explicit timestamp for the document diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_index_template.rb index 0b5666cce1..19b10015dc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_index_template.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Creates or updates an index template. - # # @option arguments [String] :name The name of the template # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one # @option arguments [String] :cause User defined reason for creating/updating the index template diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb index 2fdeb8c657..ce55678813 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Updates the index mappings. - # # @option arguments [List] :index A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb index ff46521e25..98d763187e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Updates the index settings. - # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb index 4aa27924fd..9636107606 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Creates or updates an index template. - # # @option arguments [String] :name The name of the template # @option arguments [Number] :order The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb index f53cef9ad3..0c7c31deb7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns information about ongoing index shard recoveries. - # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :detailed Whether to display detailed information about shard recovery # @option arguments [Boolean] :active_only Display only those recoveries that are currently on-going diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb index eb553db788..df58af8c7a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Performs the refresh operation in one or more indices. - # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @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) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb index b3b8b0f578..8633aae8c9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Reloads an index's search analyzers and their resources. - # # @option arguments [List] :index A comma-separated list of index names to reload analyzers for # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @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) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb index a71ec5957c..8456944bb7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Resolves the specified index expressions to return information about each cluster, including the local cluster, if included. - # # @option arguments [List] :name A comma-separated list of cluster:index names or wildcard expressions # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb index 5520b250b7..c24e13ffa3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns information about any matching indices, aliases, and data streams - # # @option arguments [List] :name A comma-separated list of names or wildcard expressions # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb index 02e5c848de..dcaae062f4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb @@ -24,7 +24,6 @@ module Indices module Actions # Updates an alias to point to a new index when the existing index # is considered to be too large or too old. - # # @option arguments [String] :alias The name of the alias to rollover # @option arguments [String] :new_index The name of the rollover index # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb index a79687228b..2188355c2b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Provides low-level information about segments in a Lucene index. - # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @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) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb index 4256286b2d..16dc90046b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Provides store information for shard copies of indices. - # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [List] :status A comma-separated list of statuses used to filter on shards to get store information for (options: green, yellow, red, all) # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb index 2b79f03b3e..2d4b29689e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Allow to shrink an existing index into a new index with fewer primary shards. - # # @option arguments [String] :index The name of the source index to shrink # @option arguments [String] :target The name of the target index to shrink into # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb index 306620414b..9ac50e33ba 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Simulate matching the given index name against the index templates in the system - # # @option arguments [String] :name The name of the index (it must be a concrete index name) # @option arguments [Boolean] :create Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb index 7346f5afcc..dbe1f2c9cd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Simulate resolving the given template name or body - # # @option arguments [String] :name The name of the index template # @option arguments [Boolean] :create Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb index e7af986f4c..bdbe2eef44 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Allows you to split an existing index into a new index with more primary shards. - # # @option arguments [String] :index The name of the source index to split # @option arguments [String] :target The name of the target index to split into # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb index 79a3728a2f..df2fdf3618 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Provides statistics on operations happening in an index. - # # @option arguments [List] :metric Limit the information returned the specific metrics. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, bulk) # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [List] :completion_fields A comma-separated list of fields for the `completion` index metric (supports wildcards) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb index e09d51e3f8..6c8c538875 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again. - # # @option arguments [String] :index The name of the index to unfreeze # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb index 20843eb693..7f035578cc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Updates index aliases. - # # @option arguments [Time] :timeout Request timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb index 792b79bde9..92eb349c47 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Allows a user to validate a potentially expensive query without executing it. - # # @option arguments [List] :index A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :explain Return detailed information about the error # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb index 3e16f37413..cd7ebe57c0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb @@ -23,7 +23,6 @@ module API module Ingest module Actions # Deletes a pipeline. - # # @option arguments [String] :id Pipeline ID # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb index 5fc5a07ce3..d235afcbd1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb @@ -23,7 +23,6 @@ module API module Ingest module Actions # Returns a pipeline. - # # @option arguments [String] :id Comma separated list of pipeline ids. Wildcards supported # @option arguments [Boolean] :summary Return pipelines without their definitions (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb index 33e505538c..c758ad20bb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb @@ -23,7 +23,6 @@ module API module Ingest module Actions # Creates or updates a pipeline. - # # @option arguments [String] :id Pipeline ID # @option arguments [Integer] :if_version Required version for optimistic concurrency control for pipeline updates # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb index 9f9d7aa5d3..f952934ba3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb @@ -23,7 +23,6 @@ module API module Ingest module Actions # Allows to simulate a pipeline with example documents. - # # @option arguments [String] :id Pipeline ID # @option arguments [Boolean] :verbose Verbose mode. Display data output for each processor in executed pipeline # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb index 01b7e86663..74189ccef7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb @@ -23,7 +23,6 @@ module API module License module Actions # Retrieves licensing information for the cluster - # # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Boolean] :accept_enterprise Supported for backwards compatibility with 7.x. If this param is used it must be set to true *Deprecated* # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb index 0196d30784..88a4a1c293 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb @@ -23,7 +23,6 @@ module API module License module Actions # Updates the license for the cluster. - # # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body licenses to be installed diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb index efbc57a82b..d0d9459cfb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb @@ -23,7 +23,6 @@ module API module License module Actions # Starts an indefinite basic license. - # # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb index 6f8e145b57..8dfe8eb19d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb @@ -23,7 +23,6 @@ module API module License module Actions # starts a limited time trial license. - # # @option arguments [String] :type The type of trial license to generate (default: "trial") # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb index f2343a90a4..e5fc61dcbc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb @@ -23,7 +23,6 @@ module API module Logstash module Actions # Deletes Logstash Pipelines used by Central Management - # # @option arguments [String] :id The ID of the Pipeline # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb index 3d79d9a5f3..e400ca0181 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb @@ -23,7 +23,6 @@ module API module Logstash module Actions # Retrieves Logstash Pipelines used by Central Management - # # @option arguments [String] :id A comma-separated list of Pipeline IDs # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb index ec2d3db074..4120c8b1d2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb @@ -23,7 +23,6 @@ module API module Logstash module Actions # Adds and updates Logstash Pipelines used for Central Management - # # @option arguments [String] :id The ID of the Pipeline # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The Pipeline to add or update (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb index 51f148fd4d..84e1ada661 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Clear the cached results from a trained model deployment - # # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/close_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/close_job.rb index 402379986f..ca87b52699 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/close_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/close_job.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle. - # # @option arguments [String] :job_id The name of the job to close # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) # @option arguments [Boolean] :force True if the job should be forcefully closed diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb index 7dc9621c8e..27755cc5a9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes a calendar. - # # @option arguments [String] :calendar_id The ID of the calendar to delete # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb index e4e078dd62..ae64667e7c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes scheduled events from a calendar. - # # @option arguments [String] :calendar_id The ID of the calendar to modify # @option arguments [String] :event_id The ID of the event to remove from the calendar # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb index bf8c27c181..c7261686be 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes anomaly detection jobs from a calendar. - # # @option arguments [String] :calendar_id The ID of the calendar to modify # @option arguments [String] :job_id The ID of the job to remove from the calendar # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb index 2d6cc6d628..86d9f147b1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes an existing data frame analytics job. - # # @option arguments [String] :id The ID of the data frame analytics to delete # @option arguments [Boolean] :force True if the job should be forcefully deleted # @option arguments [Time] :timeout Controls the time to wait until a job is deleted. Defaults to 1 minute diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb index e390df0049..7dec3a0f3b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes an existing datafeed. - # # @option arguments [String] :datafeed_id The ID of the datafeed to delete # @option arguments [Boolean] :force True if the datafeed should be forcefully deleted # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb index 9b12cbc8d7..34e681eccc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes expired and unused machine learning data. - # # @option arguments [String] :job_id The ID of the job(s) to perform expired data hygiene for # @option arguments [Number] :requests_per_second The desired requests per second for the deletion processes. # @option arguments [Time] :timeout How long can the underlying delete processes run until they are canceled diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb index d4c0c459e4..11317ba90d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes a filter. - # # @option arguments [String] :filter_id The ID of the filter to delete # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb index f44f54c894..b89f2bf7a9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes forecasts from a machine learning job. - # # @option arguments [String] :job_id The ID of the job from which to delete forecasts # @option arguments [String] :forecast_id The ID of the forecast to delete, can be comma delimited list. Leaving blank implies `_all` # @option arguments [Boolean] :allow_no_forecasts Whether to ignore if `_all` matches no forecasts diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_job.rb index eb3ae0999b..57aefe8cf0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_job.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes an existing anomaly detection job. - # # @option arguments [String] :job_id The ID of the job to delete # @option arguments [Boolean] :force True if the job should be forcefully deleted # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb index d183076db6..5b20fe0b47 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes an existing model snapshot. - # # @option arguments [String] :job_id The ID of the job to fetch # @option arguments [String] :snapshot_id The ID of the snapshot to delete # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb index e3a9517366..7b886f1f47 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes an existing trained inference model that is currently not referenced by an ingest pipeline. - # # @option arguments [String] :model_id The ID of the trained model to delete # @option arguments [Time] :timeout Controls the amount of time to wait for the model to be deleted. # @option arguments [Boolean] :force True if the model should be forcefully deleted diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb index c1ee724d4d..400b1fbd1f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes a model alias that refers to the trained model - # # @option arguments [String] :model_alias The trained model alias to delete # @option arguments [String] :model_id The trained model where the model alias is assigned # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb index a28f4a7050..b90b5f8cfa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Explains a data frame analytics config. - # # @option arguments [String] :id The ID of the data frame analytics to explain # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The data frame analytics config to explain diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb index b35cc7ba26..371c12223e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Forces any buffered data to be processed by the job. - # # @option arguments [String] :job_id The name of the job to flush # @option arguments [Boolean] :calc_interim Calculates interim results for the most recent bucket or all buckets within the latency period # @option arguments [String] :start When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb index f2278ab5e4..b100d9e9ac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Predicts the future behavior of a time series by using its historical behavior. - # # @option arguments [String] :job_id The ID of the job to forecast for # @option arguments [Time] :duration The duration of the forecast # @option arguments [Time] :expires_in The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb index 7ba1ae3113..9d9f7db52f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves anomaly detection job results for one or more buckets. - # # @option arguments [String] :job_id ID of the job to get bucket results from # @option arguments [String] :timestamp The timestamp of the desired single bucket result # @option arguments [Boolean] :expand Include anomaly records diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb index 23538f27df..084b5aa50a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves information about the scheduled events in calendars. - # # @option arguments [String] :calendar_id The ID of the calendar containing the events # @option arguments [String] :job_id Get events for the job. When this option is used calendar_id must be '_all' # @option arguments [String] :start Get events after this time diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb index 4372a15eaf..5e46438dd7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves configuration information for calendars. - # # @option arguments [String] :calendar_id The ID of the calendar to fetch # @option arguments [Integer] :from skips a number of calendars # @option arguments [Integer] :size specifies a max number of calendars to get diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb index 1c3192b2e6..fb2b1e3ac5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves anomaly detection job results for one or more categories. - # # @option arguments [String] :job_id The name of the job # @option arguments [Long] :category_id The identifier of the category definition of interest # @option arguments [Integer] :from skips a number of categories diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb index 4b9343e96c..221dc4c18c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves configuration information for data frame analytics jobs. - # # @option arguments [String] :id The ID of the data frame analytics to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) # @option arguments [Integer] :from skips a number of analytics diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb index 8321f40830..4ccfcf27c9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves usage information for data frame analytics jobs. - # # @option arguments [String] :id The ID of the data frame analytics stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) # @option arguments [Integer] :from skips a number of analytics diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb index 78d63dc27f..4e64d4ac2b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves usage information for datafeeds. - # # @option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb index 9aa7a150bf..92407e54eb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves configuration information for datafeeds. - # # @option arguments [String] :datafeed_id The ID of the datafeeds to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on datafeed PUT diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_filters.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_filters.rb index 61dbb2771c..0aa758515b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_filters.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_filters.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves filters. - # # @option arguments [String] :filter_id The ID of the filter to fetch # @option arguments [Integer] :from skips a number of filters # @option arguments [Integer] :size specifies a max number of filters to get diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb index 568f73772a..193bb23ee3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves anomaly detection job results for one or more influencers. - # # @option arguments [String] :job_id Identifier for the anomaly detection job # @option arguments [Boolean] :exclude_interim Exclude interim results # @option arguments [Integer] :from skips a number of influencers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb index 559a9a163b..476e0a7e4d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves usage information for anomaly detection jobs. - # # @option arguments [String] :job_id The ID of the jobs stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb index 8e7d065185..73e7002c64 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves configuration information for anomaly detection jobs. - # # @option arguments [String] :job_id The ID of the jobs to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on job PUT diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb index 8f7c63a8b0..b4870df708 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Returns information on how ML is using memory. - # # @option arguments [String] :node_id Specifies the node or nodes to retrieve stats for. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb index c5030e1752..136e2b0884 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Gets stats for anomaly detection job model snapshot upgrades that are in progress. - # # @option arguments [String] :job_id The ID of the job. May be a wildcard, comma separated list or `_all`. # @option arguments [String] :snapshot_id The ID of the snapshot. May be a wildcard, comma separated list or `_all`. # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs or no snapshots. (This includes the `_all` string.) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb index 3f12d30b47..01bf8ecc37 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves information about model snapshots. - # # @option arguments [String] :job_id The ID of the job to fetch # @option arguments [String] :snapshot_id The ID of the snapshot to fetch # @option arguments [Integer] :from Skips a number of documents diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb index b182b64c11..58af980428 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs. - # # @option arguments [String] :job_id The job IDs for which to calculate overall bucket results # @option arguments [Integer] :top_n The number of top job bucket scores to be used in the overall_score calculation # @option arguments [String] :bucket_span The span of the overall buckets. Defaults to the longest job bucket_span diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb index c738c47aaa..bcaf786e27 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves anomaly records for an anomaly detection job. - # # @option arguments [String] :job_id The ID of the job # @option arguments [Boolean] :exclude_interim Exclude interim results # @option arguments [Integer] :from skips a number of records diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb index 769069774d..bd0dc2627f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves configuration information for a trained inference model. - # # @option arguments [String] :model_id The ID of the trained models to fetch # @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) # @option arguments [String] :include A comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. Default is none. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb index 8236a20828..a8791d7e66 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves usage information for trained inference models. - # # @option arguments [String] :model_id The ID of the trained models stats to fetch # @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) # @option arguments [Integer] :from skips a number of trained models diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb index f424069879..6c1578cbf5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Evaluate a trained model. - # # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) # @option arguments [Time] :timeout Controls the amount of time to wait for inference results. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/open_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/open_job.rb index c54936bb36..a63e2acd98 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/open_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/open_job.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Opens one or more anomaly detection jobs. - # # @option arguments [String] :job_id The ID of the job to open # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Query parameters can be specified in the body diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb index 0f34975f26..70c43487ce 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Posts scheduled events in a calendar. - # # @option arguments [String] :calendar_id The ID of the calendar to modify # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body A list of events (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb index cf05d9ecfd..bfb966fc82 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Sends data to an anomaly detection job for analysis. - # # @option arguments [String] :job_id The name of the job receiving the data # @option arguments [String] :reset_start Optional parameter to specify the start of the bucket resetting range # @option arguments [String] :reset_end Optional parameter to specify the end of the bucket resetting range diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb index fa49be20e8..91a203f372 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Previews that will be analyzed given a data frame analytics config. - # # @option arguments [String] :id The ID of the data frame analytics to preview # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The data frame analytics config to preview diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb index 1b9adde65d..b4a7093a90 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Previews a datafeed. - # # @option arguments [String] :datafeed_id The ID of the datafeed to preview # @option arguments [String] :start The start time from where the datafeed preview should begin # @option arguments [String] :end The end time when the datafeed preview should stop diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb index b6d8d91815..c2a4b5793f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Instantiates a calendar. - # # @option arguments [String] :calendar_id The ID of the calendar to create # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The calendar details diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb index c8502ef4f4..b22ab27e95 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Adds an anomaly detection job to a calendar. - # # @option arguments [String] :calendar_id The ID of the calendar to modify # @option arguments [String] :job_id The ID of the job to add to the calendar # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb index 775f0bf297..b00933f0e8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Instantiates a data frame analytics job. - # # @option arguments [String] :id The ID of the data frame analytics to create # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The data frame analytics configuration (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb index 6e66c4e8f2..5f6ebffae1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Instantiates a datafeed. - # # @option arguments [String] :datafeed_id The ID of the datafeed to create # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) # @option arguments [Boolean] :allow_no_indices Ignore if the source indices expressions resolves to no concrete indices (default: true) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_filter.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_filter.rb index 90f56b300d..4f04d93747 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_filter.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_filter.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Instantiates a filter. - # # @option arguments [String] :filter_id The ID of the filter to create # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The filter details (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_job.rb index 7dd3d87fcd..621b570a34 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_job.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Instantiates an anomaly detection job. - # # @option arguments [String] :job_id The ID of the job to create # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false). Only set if datafeed_config is provided. # @option arguments [Boolean] :allow_no_indices Ignore if the source indices expressions resolves to no concrete indices (default: true). Only set if datafeed_config is provided. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb index 112635a7cb..a51cca2c90 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Creates an inference trained model. - # # @option arguments [String] :model_id The ID of the trained models to store # @option arguments [Boolean] :defer_definition_decompression If set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations. # @option arguments [Boolean] :wait_for_completion Whether to wait for all child operations(e.g. model download) to complete, before returning or not. Default to false diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb index 4b590815e1..8b53b7812a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Creates a new model alias (or reassigns an existing one) to refer to the trained model - # # @option arguments [String] :model_alias The trained model alias to update # @option arguments [String] :model_id The trained model where the model alias should be assigned # @option arguments [Boolean] :reassign If the model_alias already exists and points to a separate model_id, this parameter must be true. Defaults to false. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb index 03e2e058d0..416c66ed88 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Creates part of a trained model definition - # # @option arguments [String] :model_id The ID of the trained model for this definition part # @option arguments [Integer] :part The part number # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb index 6dc94d6dd5..c19e133e3b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Creates a trained model vocabulary - # # @option arguments [String] :model_id The ID of the trained model for this vocabulary # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The trained model vocabulary (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/reset_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/reset_job.rb index 3eb8d34cd7..3edb621fc0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/reset_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/reset_job.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Resets an existing anomaly detection job. - # # @option arguments [String] :job_id The ID of the job to reset # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning # @option arguments [Boolean] :delete_user_annotations Should annotations added by the user be deleted diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb index 137769bd3a..7b9c67434f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Reverts to a specific snapshot. - # # @option arguments [String] :job_id The ID of the job to fetch # @option arguments [String] :snapshot_id The ID of the snapshot to revert to # @option arguments [Boolean] :delete_intervening_results Should we reset the results back to the time of the snapshot? diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb index 0fdfa4c07c..a450f4f508 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. - # # @option arguments [Boolean] :enabled Whether to enable upgrade_mode ML setting or not. Defaults to false. # @option arguments [Time] :timeout Controls the time to wait before action times out. Defaults to 30 seconds # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb index ff4f473e48..33f88b2a7a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Starts a data frame analytics job. - # # @option arguments [String] :id The ID of the data frame analytics to start # @option arguments [Time] :timeout Controls the time to wait until the task has started. Defaults to 20 seconds # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb index 461ecf6433..75e6f148bd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Starts one or more datafeeds. - # # @option arguments [String] :datafeed_id The ID of the datafeed to start # @option arguments [String] :start The start time from where the datafeed should begin # @option arguments [String] :end The end time when the datafeed should stop. When not set, the datafeed continues in real time diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb index d6ba831086..b4ff858096 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Start a trained model deployment. - # # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) # @option arguments [String] :cache_size A byte-size value for configuring the inference cache size. For example, 20mb. # @option arguments [String] :deployment_id The Id of the new deployment. Defaults to the model_id if not set. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb index 3bb6a923dd..55b068930b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Stops one or more data frame analytics jobs. - # # @option arguments [String] :id The ID of the data frame analytics to stop # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) # @option arguments [Boolean] :force True if the data frame analytics should be forcefully stopped diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb index ef183a600b..88609a447c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Stops one or more datafeeds. - # # @option arguments [String] :datafeed_id The ID of the datafeed to stop # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) # @option arguments [Boolean] :allow_no_datafeeds Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) *Deprecated* diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb index 0ef0ad5215..fa7bd924a8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Stop a trained model deployment. - # # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no deployments. (This includes `_all` string or when no deployments have been specified) # @option arguments [Boolean] :force True if the deployment should be forcefully stopped diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb index 25cac4e808..e5088cc11b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Updates certain properties of a data frame analytics job. - # # @option arguments [String] :id The ID of the data frame analytics to update # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The data frame analytics settings to update (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb index 718b3faa4d..24ecb5e4ab 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Updates certain properties of a datafeed. - # # @option arguments [String] :datafeed_id The ID of the datafeed to update # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) # @option arguments [Boolean] :allow_no_indices Ignore if the source indices expressions resolves to no concrete indices (default: true) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_filter.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_filter.rb index 44b5c17eed..da0254824f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_filter.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_filter.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Updates the description of a filter, adds items, or removes items. - # # @option arguments [String] :filter_id The ID of the filter to update # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The filter update (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_job.rb index 8db85f2dbc..70cf948892 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_job.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Updates certain properties of an anomaly detection job. - # # @option arguments [String] :job_id The ID of the job to create # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The job update settings (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb index a848ab1a26..1c1bb7a83f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Updates certain properties of a snapshot. - # # @option arguments [String] :job_id The ID of the job to fetch # @option arguments [String] :snapshot_id The ID of the snapshot to update # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb index bcb7f20dc9..5f151349ce 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Upgrades a given job snapshot to the current major version. - # # @option arguments [String] :job_id The ID of the job # @option arguments [String] :snapshot_id The ID of the snapshot # @option arguments [Time] :timeout How long should the API wait for the job to be opened and the old snapshot to be loaded. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb b/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb index 3bdbf69832..00c604ea01 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Allows to get multiple documents in one request. - # # @option arguments [String] :index The name of the index # @option arguments [Boolean] :force_synthetic_source Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb b/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb index 5b8ce9c6dd..8b0ad12f71 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb @@ -23,7 +23,6 @@ module API module Migration module Actions # Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version. - # # @option arguments [String] :index Index pattern # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb b/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb index 098f8b8f2f..cd6a5f5420 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb @@ -23,7 +23,6 @@ module API module Monitoring module Actions # Used by the monitoring features to send monitoring data. - # # @option arguments [String] :type Default document type for items which don't provide one *Deprecated* # @option arguments [String] :system_id Identifier of the monitored system # @option arguments [String] :system_api_version API Version of the monitored system diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb index b14bae7f92..624c302448 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Allows to execute several search operations in one request. - # # @option arguments [List] :index A comma-separated list of index names to use as default # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch) # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb index e475483b76..a729f21d9b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Allows to execute several search template operations in one request. - # # @option arguments [List] :index A comma-separated list of index names to use as default # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch) # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb b/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb index 98d130fe45..b7c96f5017 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns multiple termvectors in one request. - # # @option arguments [String] :index The index in which the document resides. # @option arguments [List] :ids A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb index 834bbece04..682c690974 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb @@ -23,7 +23,6 @@ module API module Nodes module Actions # Returns information about hot threads on each node in the cluster. - # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes # @option arguments [Time] :interval The interval for the second sampling of threads # @option arguments [Number] :snapshots Number of samples of thread stacktrace (default: 10) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb index d40771fb55..ccb64adb04 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb @@ -23,7 +23,6 @@ module API module Nodes module Actions # Returns information about nodes in the cluster. - # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes # @option arguments [List] :metric A comma-separated list of metrics you wish returned. Use `_all` to retrieve all metrics and `_none` to retrieve the node identity without any additional metrics. (options: settings, os, process, jvm, thread_pool, transport, http, plugins, ingest, indices, aggregations, _all, _none) # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb index 185cc27c3d..dc9100aece 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb @@ -23,7 +23,6 @@ module API module Nodes module Actions # Reloads secure settings. - # # @option arguments [List] :node_id A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes. # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb index 38347ff096..5467dd7244 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb @@ -23,7 +23,6 @@ module API module Nodes module Actions # Returns statistical information about nodes in the cluster. - # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, breaker, fs, http, indices, jvm, os, process, thread_pool, transport, discovery, indexing_pressure) # @option arguments [List] :index_metric Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, bulk, shard_stats) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb index a26eb781b7..f60c5c05ea 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb @@ -23,7 +23,6 @@ module API module Nodes module Actions # Returns low-level information about REST actions usage on nodes. - # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, rest_actions) # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb b/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb index bed276aa16..11890110f1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Open a point in time that can be used in subsequent searches - # # @option arguments [List] :index A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) # @option arguments [String] :routing Specific routing value diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/status.rb index fab464135e..7a87ba59f7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/status.rb @@ -23,7 +23,6 @@ module API module Profiling module Actions # Returns basic information about the status of Universal Profiling. - # # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Boolean] :wait_for_resources_created Whether to return immediately or wait until resources have been created diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb b/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb index 1a66e5c7dc..93a6a66556 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Creates or updates a script. - # # @option arguments [String] :id Script ID # @option arguments [String] :context Script context # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb index a16e832a10..89b4af233b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Allows to evaluate the quality of ranked search results over a set of typical search queries - # # @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 # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @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) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb b/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb index c0c75a54c2..4c272302e2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb @@ -24,7 +24,6 @@ module Actions # Allows to copy documents from one index to another, optionally filtering the source # documents by a query, changing the destination index settings, or fetching the # documents from a remote cluster. - # # @option arguments [Boolean] :refresh Should the affected indexes be refreshed? # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable. # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb index df9c7f19dd..932f1b9940 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Changes the number of requests per second for a particular Reindex operation. - # # @option arguments [String] :task_id The task id to rethrottle # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb index 3ec0fb5634..16b359d730 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Allows to use the Mustache language to pre-render a search definition. - # # @option arguments [String] :id The id of the stored search template # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The search definition template and its params diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb b/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb index 61283486ad..a85e1b2886 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Allows to retrieve a large numbers of results from a single search request. - # # @option arguments [String] :scroll_id The scroll ID *Deprecated* # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search.rb index e539f46c49..e2de0226f5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns results matching a query. - # # @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 # @option arguments [String] :analyzer The analyzer to use for the query string # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb index bfade1e1c5..fbb2a52bf3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns information about the indices and shards that a search request would be executed against. - # # @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 # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) # @option arguments [String] :routing Specific routing value diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb index 10c7f05d23..55221dae5b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Allows to use the Mustache language to pre-render a search definition. - # # @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 # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb index 95c44ea95f..aef22d7592 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb @@ -23,7 +23,6 @@ module API module SearchableSnapshots module Actions # Mount a snapshot as a searchable index. - # # @option arguments [String] :repository The name of the repository containing the snapshot of the index to mount # @option arguments [String] :snapshot The name of the snapshot of the index to mount # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb index f2a64aa355..f2b3f64884 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb @@ -23,7 +23,6 @@ module API module SearchableSnapshots module Actions # Retrieve shard-level statistics about searchable snapshots. - # # @option arguments [List] :index A comma-separated list of index names # @option arguments [String] :level Return stats aggregated at cluster, index or shard level (options: cluster, indices, shards) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb index 5b494208f7..304074f3ae 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Changes the passwords of users in the native realm and built-in users. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb index 8b8f094626..2166a9eca5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Clear a subset or all entries from the API key cache. - # # @option arguments [List] :ids A comma-separated list of IDs of API keys to clear from the cache # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb index 201ea736c9..f10a858ac4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Evicts application privileges from the native application privileges cache. - # # @option arguments [List] :application A comma-separated list of application names # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_realms.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_realms.rb index 23ab5630d9..c51386da7a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_realms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_realms.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Evicts users from the user cache. Can completely clear the cache or evict specific users. - # # @option arguments [List] :realms Comma-separated list of realms to clear # @option arguments [List] :usernames Comma-separated list of usernames to clear from the cache # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_roles.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_roles.rb index 7abb1aa9d5..10be2bb56d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_roles.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_roles.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Evicts roles from the native role cache. - # # @option arguments [List] :name Role name # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb index d1e564ce20..7aefd8df8b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Evicts tokens from the service account token caches. - # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name # @option arguments [List] :name A comma-separated list of service token names diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_api_key.rb index f85f001ffb..4487f0a4c0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_api_key.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Creates an API key for access without requiring basic authentication. - # # @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-api/lib/elasticsearch/api/actions/security/create_service_token.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_service_token.rb index 7677e0a468..89b2f78174 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_service_token.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_service_token.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Creates a service account token for access without requiring basic authentication. - # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name # @option arguments [String] :name An identifier for the token name diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb index 84d69f9302..4f143bee15 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Removes application privileges. - # # @option arguments [String] :application Application name # @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) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb index dc0ae04c3e..84093fd14b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Removes roles in the native realm. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role_mapping.rb index 7e280f4fb0..91be5e3fa4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role_mapping.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Removes role mappings. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_service_token.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_service_token.rb index a35eb622a2..866a7d236d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_service_token.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_service_token.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Deletes a service account token. - # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name # @option arguments [String] :name An identifier for the token name diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb index 0376a013bd..13d8a59618 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Deletes users from the native realm. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb index 17f11502d8..c1c6974689 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Disables users in the native realm. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user_profile.rb index d8b225017a..9737ca4ff8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user_profile.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user_profile.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Disables a user profile so it's not visible in user profile searches. - # # @option arguments [String] :uid Unique identifier for the user profile # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) 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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb index 070e62f4c8..9def186307 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Enables users in the native realm. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user_profile.rb index 1f7ff9ebf2..b27e2dab85 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user_profile.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user_profile.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Enables a user profile so it's visible in user profile searches. - # # @option arguments [String] :uid An unique identifier of the user profile # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) 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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_api_key.rb index b3bbad25d8..7bbad938cc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_api_key.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves information for one or more API keys. - # # @option arguments [String] :id API key id of the API key to be retrieved # @option arguments [String] :name API key name of the API key to be retrieved # @option arguments [String] :username user name of the user who created this API key to be retrieved diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb index 0924eed75a..69dc58b3a1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves application privileges. - # # @option arguments [String] :application Application name # @option arguments [String] :name Privilege name # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb index f666bbc86d..085f06543d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves roles in the native realm. - # # @option arguments [List] :name A comma-separated list of role names # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role_mapping.rb index 0ee5e0eb6a..98d2f7ac00 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role_mapping.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves role mappings. - # # @option arguments [List] :name A comma-separated list of role-mapping names # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_accounts.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_accounts.rb index 18c647b5b9..4d71cd9ce1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_accounts.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_accounts.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves information about service accounts. - # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_credentials.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_credentials.rb index c22310a210..7d0ea91314 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_credentials.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_credentials.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves information of all service credentials for a service account. - # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb index 2bc57fdb19..24eeb2e504 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves information about users in the native realm and built-in users. - # # @option arguments [List] :username A comma-separated list of usernames # @option arguments [Boolean] :with_profile_uid flag to retrieve profile uid (if exists) associated to the user # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_profile.rb index bfb534ec18..649755be8a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_profile.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_profile.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves user profiles for the given unique ID(s). - # # @option arguments [List] :uid A comma-separated list of unique identifier for user profiles # @option arguments [List] :data A comma-separated list of keys for which the corresponding application data are retrieved. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb index 15fb259906..2d68d806e5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Creates an API key on behalf of another 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 api key request to create an API key (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb index 464524bcf7..1471cd7fae 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Determines whether the specified user has a specified list of privileges. - # # @option arguments [String] :user Username # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The privileges to test (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb index fa46efaeba..b29856ff04 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Adds or updates application privileges. - # # @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-api/lib/elasticsearch/api/actions/security/put_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb index 4dcb45b339..727147039f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Adds and updates roles in the native realm. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role_mapping.rb index 14dc932504..09db6cc2fe 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role_mapping.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Creates and updates role mappings. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb index 97520df8f9..8f02e8cebe 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Adds and updates users in the native realm. These users are commonly referred to as native users. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb index a240680ca3..03f7a834ff 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves information for API keys using a subset of query DSL - # # @option arguments [Boolean] :with_limited_by flag to show the limited-by role descriptors of API Keys # @option arguments [Boolean] :with_profile_uid flag to also retrieve the API Key's owner profile uid, if it exists # @option arguments [Boolean] :typed_keys flag to prefix aggregation names by their respective types in the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb index f20ccba614..17d2f65ee1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves information for Users using a subset of query DSL - # # @option arguments [Boolean] :with_profile_uid flag to retrieve profile uid (if exists) associated with the user # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body From, size, query, sort and search_after diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb index 9a21ed04cf..6ba70c72d5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider - # # @option arguments [String] :realm_name The name of the SAML realm to get the metadata for # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb index 45fbfb9d9d..7f3d5363e3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Get suggestions for user profiles that match specified search criteria. - # # @option arguments [List] :data A comma-separated list of keys for which the corresponding application data are retrieved. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The suggestion definition for user profiles diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_api_key.rb index 144eae350e..239b1bf211 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_api_key.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Updates attributes of an existing API key. - # # @option arguments [String] :id The ID of the API key to update # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The API key request to update attributes of an API key. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_user_profile_data.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_user_profile_data.rb index 98caf1fe16..8506aa0ae2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_user_profile_data.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_user_profile_data.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Update application specific data for the user profile of the given unique ID. - # # @option arguments [String] :uid An unique identifier of the user profile # @option arguments [Number] :if_seq_no only perform the update operation if the last operation that has changed the document has the specified sequence number # @option arguments [Number] :if_primary_term only perform the update operation if the last operation that has changed the document has the specified primary term diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/delete_node.rb b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/delete_node.rb index f56dad05b3..e80042a35d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/delete_node.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/delete_node.rb @@ -23,7 +23,6 @@ module API module Shutdown module Actions # Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. - # # @option arguments [String] :node_id The node id of node to be removed from the shutdown state # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/get_node.rb b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/get_node.rb index f7d62070cb..070e3aea15 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/get_node.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/get_node.rb @@ -23,7 +23,6 @@ module API module Shutdown module Actions # Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. - # # @option arguments [String] :node_id Which node for which to retrieve the shutdown status # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb index a8f49a550a..1ef5f35e1e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb @@ -23,7 +23,6 @@ module API module Shutdown module Actions # Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. - # # @option arguments [String] :node_id The node id of node to be shut down # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The shutdown type definition to register (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb index d691224bfc..34078563a1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Removes stale data from repository. - # # @option arguments [String] :repository A repository name # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb index 4a35814321..1eda6a797d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Clones indices from one snapshot into another snapshot in the same repository. - # # @option arguments [String] :repository A repository name # @option arguments [String] :snapshot The name of the snapshot to clone from # @option arguments [String] :target_snapshot The name of the cloned snapshot to create diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb index c59d23e023..067f4f3529 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Creates a snapshot in a repository. - # # @option arguments [String] :repository A repository name # @option arguments [String] :snapshot A snapshot name # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb index 2bd50205f0..6d8a2cfc0d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Creates a repository. - # # @option arguments [String] :repository A repository name # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb index e7b9596610..cc5f2efbdd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Deletes one or more snapshots. - # # @option arguments [String] :repository A repository name # @option arguments [List] :snapshot A comma-separated list of snapshot names # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb index 35d74ca656..dd052913bb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Deletes a repository. - # # @option arguments [List] :repository Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb index 481d9baea0..501a1df4d5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Returns information about a snapshot. - # # @option arguments [String] :repository A repository name # @option arguments [List] :snapshot A comma-separated list of snapshot names # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb index c00291017c..532e7b3a99 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Returns information about a repository. - # # @option arguments [List] :repository A comma-separated list of repository names # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb index 4ca7db20c6..e76bdf0067 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Analyzes a repository for correctness and performance - # # @option arguments [String] :repository A repository name # @option arguments [Number] :blob_count Number of blobs to create during the test. Defaults to 100. # @option arguments [Number] :concurrency Number of operations to run concurrently during the test. Defaults to 10. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb index 12122285d6..d44b31fb57 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Restores a snapshot. - # # @option arguments [String] :repository A repository name # @option arguments [String] :snapshot A snapshot name # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb index 7578296ea6..4fdf9c5c2c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Returns information about the status of a snapshot. - # # @option arguments [String] :repository A repository name # @option arguments [List] :snapshot A comma-separated list of snapshot names # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb index 74ff4b4f24..93f6de32ac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Verifies a repository. - # # @option arguments [String] :repository A repository name # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb index 03835b1b10..83c8c56fd4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb @@ -23,7 +23,6 @@ module API module SnapshotLifecycleManagement module Actions # Deletes an existing snapshot lifecycle policy. - # # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to remove # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb index 85708f1f6f..169f3882b8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb @@ -23,7 +23,6 @@ module API module SnapshotLifecycleManagement module Actions # Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. - # # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to be executed # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb index c8811ccaa3..2a4357ed49 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb @@ -23,7 +23,6 @@ module API module SnapshotLifecycleManagement module Actions # Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. - # # @option arguments [List] :policy_id Comma-separated list of snapshot lifecycle policies to retrieve # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb index c09ee86dca..d4ecc31f54 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb @@ -23,7 +23,6 @@ module API module SnapshotLifecycleManagement module Actions # Creates or updates a snapshot lifecycle policy. - # # @option arguments [String] :policy_id The id of the snapshot lifecycle policy # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The snapshot lifecycle policy definition to register diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb index 673137c817..45bca408e6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb @@ -23,7 +23,6 @@ module API module SQL module Actions # Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. - # # @option arguments [String] :id The async search ID # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb index 4921a3c73f..c10b358299 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb @@ -23,7 +23,6 @@ module API module SQL module Actions # Returns the current status and available results for an async SQL search or stored synchronous SQL search - # # @option arguments [String] :id The async search ID # @option arguments [String] :delimiter Separator for CSV results # @option arguments [String] :format Short version of the Accept header, e.g. json, yaml diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async_status.rb index e8bf1aecb1..739fbbbde7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async_status.rb @@ -23,7 +23,6 @@ module API module SQL module Actions # Returns the current status of an async SQL search or a stored synchronous SQL search - # # @option arguments [String] :id The async search ID # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb index 54a2bb8d8d..068bca2bd3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb @@ -23,7 +23,6 @@ module API module SQL module Actions # Executes a SQL request - # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Use the `query` element to start a query. Use the `cursor` element to continue a query. (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb index 10a742d427..a67c0e7b21 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb @@ -23,7 +23,6 @@ module API module Synonyms module Actions # Deletes a synonym set - # # @option arguments [String] :id The id of the synonyms set to be deleted # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb index 152ea64b40..cde3c03387 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb @@ -23,7 +23,6 @@ module API module Synonyms module Actions # Deletes a synonym rule in a synonym set - # # @option arguments [String] :set_id The id of the synonym set to be updated # @option arguments [String] :rule_id The id of the synonym rule to be deleted # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb index a89e5eec34..496769c031 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb @@ -23,7 +23,6 @@ module API module Synonyms module Actions # Retrieves a synonym set - # # @option arguments [String] :id The name of the synonyms set to be retrieved # @option arguments [Integer] :from Starting offset # @option arguments [Integer] :size specifies a max number of results to get diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb index 30097ab3c1..fee8c2ead2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb @@ -23,7 +23,6 @@ module API module Synonyms module Actions # Retrieves a synonym rule from a synonym set - # # @option arguments [String] :set_id The id of the synonym set to retrieve the synonym rule from # @option arguments [String] :rule_id The id of the synonym rule to retrieve # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb index c3dbf52f1c..1de6062c82 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb @@ -23,7 +23,6 @@ module API module Synonyms module Actions # Retrieves a summary of all defined synonym sets - # # @option arguments [Integer] :from Starting offset # @option arguments [Integer] :size specifies a max number of results to get # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb index b0c2914244..4c19e92deb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb @@ -23,7 +23,6 @@ module API module Synonyms module Actions # Creates or updates a synonyms set - # # @option arguments [String] :id The id of the synonyms set to be created or updated # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Synonyms set rules (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb index 148261a784..cb5eb75294 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb @@ -23,7 +23,6 @@ module API module Synonyms module Actions # Creates or updates a synonym rule in a synonym set - # # @option arguments [String] :set_id The id of the synonym set to be updated with the synonym rule # @option arguments [String] :rule_id The id of the synonym rule to be updated or created # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb b/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb index 50c955ad27..f6bc39da9a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. - # # @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 # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body field name, string which is the prefix expected in matching terms, timeout and size for max number of results diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb b/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb index e1ad38c996..348917564a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns information and statistics about terms in the fields of a particular document. - # # @option arguments [String] :index The index in which the document resides. # @option arguments [String] :id The id of the document, when not specified a doc param should be supplied. # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb index 5917d7c2e3..472f4c37d7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb @@ -23,7 +23,6 @@ module API module TextStructure module Actions # Finds the structure of a text field in an index. - # # @option arguments [String] :index The index containing the analyzed field (*Required*) # @option arguments [String] :field The field that should be analyzed (*Required*) # @option arguments [Integer] :documents_to_sample How many documents should be included in the analysis diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb index fdf6ff3476..91d9b65948 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb @@ -23,7 +23,6 @@ module API module TextStructure module Actions # Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch. - # # @option arguments [Time] :timeout Timeout after which the analysis will be aborted # @option arguments [String] :format Optional parameter to specify the high level file format (options: ndjson, xml, delimited, semi_structured_text) # @option arguments [List] :column_names Optional parameter containing a comma separated list of the column names for a delimited file diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_structure.rb b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_structure.rb index 9a6bc8d4fb..3d68e24a82 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_structure.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_structure.rb @@ -23,7 +23,6 @@ module API module TextStructure module Actions # Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch. - # # @option arguments [Integer] :lines_to_sample How many lines of the file should be included in the analysis # @option arguments [Integer] :line_merge_size_limit Maximum number of characters permitted in a single message when lines are merged to create messages. # @option arguments [Time] :timeout Timeout after which the analysis will be aborted diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb index c66a5afa6f..ee0957be4f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb @@ -23,7 +23,6 @@ module API module TextStructure module Actions # Tests a Grok pattern on some text. - # # @option arguments [String] :ecs_compatibility Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled' # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The Grok pattern and text. (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb index 1256b00e4b..66b15d4af8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Deletes an existing transform. - # # @option arguments [String] :transform_id The id of the transform to delete # @option arguments [Boolean] :force When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted. # @option arguments [Boolean] :delete_dest_index When `true`, the destination index is deleted together with the transform. The default value is `false`, meaning that the destination index will not be deleted. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb index 29ad3f2181..c77625196a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Retrieves configuration information for transforms. - # # @option arguments [String] :transform_id The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms # @option arguments [Integer] :from skips a number of transform configs, defaults to 0 # @option arguments [Integer] :size specifies a max number of transforms to get, defaults to 100 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform_stats.rb index e717a3712d..15e6bdca99 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform_stats.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Retrieves usage information for transforms. - # # @option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms # @option arguments [Number] :from skips a number of transform stats, defaults to 0 # @option arguments [Number] :size specifies a max number of transform stats to get, defaults to 100 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb index 70891d0948..63a9f3832a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Previews a transform. - # # @option arguments [String] :transform_id The id of the transform to preview. # @option arguments [Time] :timeout Controls the time to wait for the preview # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb index 59d051ac2a..a998aae8a8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Instantiates a transform. - # # @option arguments [String] :transform_id The id of the new transform. # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false. # @option arguments [Time] :timeout Controls the time to wait for the transform to start diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb index e9a0a0f651..9f50b9092e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Resets an existing transform. - # # @option arguments [String] :transform_id The id of the transform to reset # @option arguments [Boolean] :force When `true`, the transform is reset regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be reset. # @option arguments [Time] :timeout Controls the time to wait for the transform to reset diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb index 1da49f877e..a7b7f29822 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Schedules now a transform. - # # @option arguments [String] :transform_id The id of the transform. (*Required*) # @option arguments [Time] :timeout Controls the time to wait for the scheduling to take place # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb index 7b2e08111b..9e8534c2c5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Starts one or more transforms. - # # @option arguments [String] :transform_id The id of the transform to start # @option arguments [String] :from Restricts the set of transformed entities to those changed after this time # @option arguments [Time] :timeout Controls the time to wait for the transform to start diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb index f88d2e6ce1..1338c21899 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Stops one or more transforms. - # # @option arguments [String] :transform_id The id of the transform to stop # @option arguments [Boolean] :force Whether to force stop a failed transform or not. Default to false # @option arguments [Boolean] :wait_for_completion Whether to wait for the transform to fully stop before returning or not. Default to false diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb index 27098d9ecc..5d52873212 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Updates certain properties of a transform. - # # @option arguments [String] :transform_id The id of the transform. (*Required*) # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false. # @option arguments [Time] :timeout Controls the time to wait for the update diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb index 2f903b7b59..b04ed5d168 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Upgrades all transforms. - # # @option arguments [Boolean] :dry_run Whether to only check for updates but don't execute # @option arguments [Time] :timeout Controls the time to wait for the upgrade # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/update.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update.rb index 3fa6ae4ebf..459df728a3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Updates a document with a script or partial document. - # # @option arguments [String] :id Document ID # @option arguments [String] :index The name of the index # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb index b86e49d8be..078ca48cd9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb @@ -23,7 +23,6 @@ module API module Actions # Performs an update on every document in the index without changing the source, # for example to pick up a mapping change. - # # @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 # @option arguments [String] :analyzer The analyzer to use for the query string # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb index 319cfe3b13..fd4457fce5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Changes the number of requests per second for a particular Update By Query operation. - # # @option arguments [String] :task_id The task id to rethrottle # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb index ede507e144..337963cfb9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb @@ -23,7 +23,6 @@ module API module Watcher module Actions # Acknowledges a watch, manually throttling the execution of the watch's actions. - # # @option arguments [String] :watch_id Watch ID # @option arguments [List] :action_id A comma-separated list of the action ids to be acked # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb index f3d6f3e857..1dbab9a1d3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb @@ -23,7 +23,6 @@ module API module Watcher module Actions # Activates a currently inactive watch. - # # @option arguments [String] :watch_id Watch ID # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb index 5b0e71dc5e..25e6ccd3d5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb @@ -23,7 +23,6 @@ module API module Watcher module Actions # Deactivates a currently active watch. - # # @option arguments [String] :watch_id Watch ID # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb index 8430658dcf..a1b3f73b71 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb @@ -23,7 +23,6 @@ module API module Watcher module Actions # Removes a watch from Watcher. - # # @option arguments [String] :id Watch ID # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb index 8b853ffecc..60dac09bbc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb @@ -23,7 +23,6 @@ module API module Watcher module Actions # Forces the execution of a stored watch. - # # @option arguments [String] :id Watch ID # @option arguments [Boolean] :debug indicates whether the watch should execute in debug mode # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb index 69c3b7e65a..ab40df5891 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb @@ -23,7 +23,6 @@ module API module Watcher module Actions # Retrieves a watch by its ID. - # # @option arguments [String] :id Watch ID # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb index 86a0179fd8..4e9fe3e156 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb @@ -23,7 +23,6 @@ module API module Watcher module Actions # Creates a new watch, or updates an existing one. - # # @option arguments [String] :id Watch ID # @option arguments [Boolean] :active Specify whether the watch is in/active by default # @option arguments [Number] :version Explicit version number for concurrency control diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb index 435b2a225f..4479805d8e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb @@ -23,7 +23,6 @@ module API module Watcher module Actions # Retrieves the current Watcher metrics. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb index a1c3b7afe3..bc16bce911 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb @@ -23,7 +23,6 @@ module API module XPack module Actions # Retrieves information about the installed X-Pack features. - # # @option arguments [List] :categories Comma-separated list of info categories. Can be any of: build, license, features # @option arguments [Boolean] :accept_enterprise If this param is used it must be set to true *Deprecated* # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb index 812fa75f71..2e0f6df8d8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb @@ -23,7 +23,6 @@ module API module XPack module Actions # Retrieves usage information about the installed X-Pack features. - # # @option arguments [Time] :master_timeout Specify timeout for watch write operation # @option arguments [Hash] :headers Custom HTTP headers #