Auto-generated API code

Author: elasticmachine

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
         #

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

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

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)

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
         #

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
         #

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*)

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)

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)

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)

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)

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

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)

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

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

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)

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

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)

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

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)

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

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

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)

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

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

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

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

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)

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)

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

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)

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)

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

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

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

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

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

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)

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)

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

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)