elasticsearch-api 6.2.0 → 6.3.0

data/lib/elasticsearch/api/actions/cat/pending_tasks.rb

@@ -17,16 +17,15 @@ module Elasticsearch
         #
         #     client.cat.pending_tasks format: 'json'
         #
-        # @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument
-        # @option arguments [Boolean] :v Display column headers as part of the output
-        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
-        # @option arguments [String] :format The output format. Options: 'text', 'json'; default: 'text'
-        # @option arguments [Boolean] :help Return information about headers
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
-        #                                    (default: false)
+        # @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
+        # @option arguments [List] :h Comma-separated list of column names to display
+        # @option arguments [Boolean] :help Return help information
+        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-pending-tasks.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-pending-tasks.html
         #
         def pending_tasks(arguments={})
           method = HTTP_GET
@@ -42,12 +41,13 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:pending_tasks, [
+            :format,
             :local,
             :master_timeout,
             :h,
             :help,
-            :v,
-            :s ].freeze)
+            :s,
+            :v ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cat/plugins.rb

@@ -5,15 +5,15 @@ module Elasticsearch
 
         # Return information about installed plugins
         #
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
-        #                                    (default: false)
+        # @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
         # @option arguments [List] :h Comma-separated list of column names to display
-        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         # @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 [Boolean] :v Verbose mode. Display column headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-plugins.html
         #
         def plugins(arguments={})
           method = 'GET'
@@ -28,12 +28,13 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:plugins, [
+            :format,
             :local,
             :master_timeout,
             :h,
             :help,
-            :v,
-            :s ].freeze)
+            :s,
+            :v ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cat/recovery.rb

@@ -34,17 +34,15 @@ module Elasticsearch
         #     client.cat.recovery format: 'json'
         #
         # @option arguments [List] :index A comma-separated list of index names to limit the returned information
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, m, g)
-        # @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument
-        # @option arguments [Boolean] :v Display column headers as part of the output
-        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
-        # @option arguments [String] :format The output format. Options: 'text', 'json'; default: 'text'
-        # @option arguments [Boolean] :help Return information about headers
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
-        #                                    (default: false)
+        # @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)
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [List] :h Comma-separated list of column names to display
+        # @option arguments [Boolean] :help Return help information
+        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-recovery.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-recovery.html
         #
         def recovery(arguments={})
           index = arguments.delete(:index)
@@ -65,13 +63,13 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:recovery, [
+            :format,
             :bytes,
-            :local,
             :master_timeout,
             :h,
             :help,
-            :v,
-            :s ].freeze)
+            :s,
+            :v ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cat/repositories.rb

@@ -13,11 +13,13 @@ module Elasticsearch
         #
         #     client.cat.repositories h: 'id'
         #
+        # @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
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
-        # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-repositories.html
         #
@@ -34,11 +36,13 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:repositories, [
+            :format,
+            :local,
             :master_timeout,
             :h,
             :help,
-            :v,
-            :s ].freeze)
+            :s,
+            :v ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cat/segments.rb

@@ -10,17 +10,19 @@ module Elasticsearch
         #     puts client.cat.segments
         #
         # @option arguments [List] :index A comma-separated list of index names to limit the returned information
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, m, g)
+        # @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)
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
-        # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-segments.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-segments.html
         #
         def segments(arguments={})
           method = 'GET'
-          path   = "_cat/segments"
+          index = arguments.delete(:index)
+          path = Utils.__pathify( '_cat/segments', Utils.__escape(index))
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           body   = nil
 
@@ -31,12 +33,12 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:segments, [
+            :format,
             :bytes,
-            :index,
             :h,
             :help,
-            :v,
-            :s ].freeze)
+            :s,
+            :v ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cat/shards.rb

@@ -38,17 +38,16 @@ module Elasticsearch
         #     client.cat.shards format: 'json'
         #
         # @option arguments [List] :index A comma-separated list of index names to limit the returned information
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, m, g)
-        # @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument
-        # @option arguments [Boolean] :v Display column headers as part of the output
-        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
-        # @option arguments [String] :format The output format. Options: 'text', 'json'; default: 'text'
-        # @option arguments [Boolean] :help Return information about headers
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
-        #                                    (default: false)
+        # @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)
+        # @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
+        # @option arguments [List] :h Comma-separated list of column names to display
+        # @option arguments [Boolean] :help Return help information
+        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-shards.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-shards.html
         #
         def shards(arguments={})
           index = arguments.delete(:index)
@@ -67,13 +66,14 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:shards, [
+            :format,
+            :bytes,
             :local,
             :master_timeout,
-            :bytes,
             :h,
             :help,
-            :v,
-            :s ].freeze)
+            :s,
+            :v ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cat/snapshots.rb

@@ -13,11 +13,14 @@ module Elasticsearch
         #
         #     client.cat.snapshots repository: 'my_repository', h: 'id,status,start_epoch'
         #
+        # @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
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
-        # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html
         #
@@ -37,13 +40,14 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:snapshots, [
+            :format,
+            :ignore_unavailable,
             :master_timeout,
             :h,
             :help,
-            :v,
-            :s ].freeze)
+            :s,
+            :v ].freeze)
       end
     end
   end
 end
-

data/lib/elasticsearch/api/actions/cat/tasks.rb

@@ -9,14 +9,13 @@ module Elasticsearch
         # @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] :actions A comma-separated list of actions that should be returned. Leave empty to return all.
         # @option arguments [Boolean] :detailed Return detailed task information (default: false)
-        # @option arguments [String] :parent_node Return tasks with specified parent node.
         # @option arguments [Number] :parent_task Return tasks with specified parent task id. Set to -1 to return all.
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
-        # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
         #
         def tasks(arguments={})
           method = 'GET'
@@ -35,12 +34,11 @@ module Elasticsearch
             :node_id,
             :actions,
             :detailed,
-            :parent_node,
             :parent_task,
             :h,
             :help,
-            :v,
-            :s ].freeze)
+            :s,
+            :v ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cat/templates.rb

@@ -11,14 +11,15 @@ module Elasticsearch
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
-        # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-templates.html
         #
         def templates(arguments={})
           method = HTTP_GET
-          path   = "_cat/templates"
+          name = arguments.delete(:name)
+          path = Utils.__pathify( '_cat/templates', Utils.__escape(name))
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           body   = nil
 
@@ -29,14 +30,13 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:templates, [
-            :name,
             :format,
             :local,
             :master_timeout,
             :h,
             :help,
-            :v,
-            :s ].freeze)
+            :s,
+            :v ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cat/thread_pool.rb

@@ -4,7 +4,7 @@ module Elasticsearch
       module Actions
 
         # Display thread pool statistics across nodes (use the `help` parameter to display a list
-        # of avaialable thread pools)
+        # of available thread pools)
         #
         # @example Display information about all thread pools across nodes
         #
@@ -22,21 +22,17 @@ module Elasticsearch
         #
         #     puts client.cat.thread_pool h: 'host,ia,is,iq,ir,sa,ss,sq,sr', v: true
         #
-        # @option arguments [Boolean] :full_id Display the complete node ID
-        # @option arguments [String] :size The multiplier in which to display values
-        #                                  (Options: k, m, g, t, p)
-        # @option arguments [List] :thread_pool_patterns A comma-separated list of regular expressions to filter
-        #                                                the thread pools in the output
-        # @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument
-        # @option arguments [Boolean] :v Display column headers as part of the output
-        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
-        # @option arguments [String] :format The output format. Options: 'text', 'json'; default: 'text'
-        # @option arguments [Boolean] :help Return information about headers
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
-        #                                    (default: false)
+        # @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] :size The multiplier in which to display values (options: , k, m, g, t, p)
+        # @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
+        # @option arguments [List] :h Comma-separated list of column names to display
+        # @option arguments [Boolean] :help Return help information
+        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-thread-pool.html
         #
         def thread_pool(arguments={})
           method = HTTP_GET
@@ -52,15 +48,15 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:thread_pool, [
-            :full_id,
+            :format,
             :size,
             :local,
             :thread_pool_patterns,
             :master_timeout,
             :h,
             :help,
-            :v,
-            :s ].freeze)
+            :s,
+            :v ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/clear_scroll.rb

@@ -6,6 +6,7 @@ module Elasticsearch
       #
       # @option arguments [List] :scroll_id A comma-separated list of scroll IDs to clear;
       #                                     use `_all` clear all scroll search contexts
+      # @option arguments [Hash] :body A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter
       #
       # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-search-type.html#clear-scroll
       #
@@ -19,6 +20,12 @@ module Elasticsearch
 
         perform_request(method, path, params, body).body
       end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:clear_scroll, [
+      ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb

@@ -7,10 +7,9 @@ module Elasticsearch
         #
         # @option arguments [Hash] :body The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'
         # @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 [Boolean] :include_disk_info Return information about disk usage and shard sizes (default: false)
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-allocation-explain.html
         #
         def allocation_explain(arguments={})
           method = 'GET'

data/lib/elasticsearch/api/actions/cluster/get_settings.rb

@@ -10,8 +10,9 @@ module Elasticsearch
         #     client.cluster.get_settings
         #
         # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
-        # @option arguments [Boolean] :include_defaults Whether to return all default clusters setting
-        #                                               (default: false)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Boolean] :include_defaults Whether to return all default clusters setting.
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/
         #
@@ -29,6 +30,8 @@ module Elasticsearch
         # @since 6.2.0
         ParamsRegistry.register(:get_settings, [
             :flat_settings,
+            :master_timeout,
+            :timeout,
             :include_defaults ].freeze)
       end
     end