elasticsearch-api 6.2.0 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95f0862a557b65c4baf38743f4e6866d77d7d56cd21180ddc1f1fda65a5d992a
-  data.tar.gz: e18b8bc805755ddcbc2a10d4657b55ee24fb75abc84ea706e07bf5aed304f397
+  metadata.gz: 4041f561fb1eeba572e39978c8126a61f6d5f672eb927e02967c07afa795e82a
+  data.tar.gz: 1f6da8dd8630042207f6e69ffb55be11648a33013c5835055f59f28887fa590a
 SHA512:
-  metadata.gz: 724cfe9f1665465585f0b877e059463cff6cb390302d7350d5432cad3dbd49f2527192dcb3eef70be1e1270b021caa2a3189fc832c4facb68bcb5325eacde5cb
-  data.tar.gz: 337bc9605d85fd89f1be2bee5674b1e2cac4a8b9c085fd5099c39661b5e4b8fef35402d072a99aa550cb2d97391ce7c8968376b0da47954aa2efd444bef6811c
+  metadata.gz: 228212c3a32733b759dbd6dc0f006ea6cfd923d068dbb189d3c59c67c8916081ec78a2d8869d668bf75f75e1bed5fd364bd6d722bf56c2b8ce97db3c9ecb4c7a
+  data.tar.gz: f39a27ae8e93cda46cc3b6780e2a5967fb13197d809187fec0c031a4e0f63a908887764208e57a3e8daee894d7cfdbb184b1b5cd4157419bc96373cf4606ae0d

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

@@ -10,7 +10,7 @@ module Elasticsearch
       #
       # @option arguments [String] :name A benchmark name
       #
-      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-benchmark.html
       #
       def abort_benchmark(arguments={})
         method = HTTP_POST

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

@@ -45,7 +45,7 @@ module Elasticsearch
       # @option arguments [Boolean] :verbose Specify whether to return verbose statistics about each iteration
       #                                      (default: false)
       #
-      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-benchmark.html
       #
       def benchmark(arguments={})
         method = HTTP_PUT

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

@@ -49,7 +49,7 @@ module Elasticsearch
       #
       # @option arguments [String] :index Default index for items which don't provide one
       # @option arguments [String] :type Default document type for items which don't provide one
-      # @option arguments [Hash] :body The operation definition and data (action-data pairs), separated by newlines (*Required*). Note that this cannot be empty.
+      # @option arguments [Hash] :body The operation definition and data (action-data pairs), separated by newlines (*Required*) Note that this cannot be empty.
       # @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 effected 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)
       # @option arguments [String] :routing Specific routing value
@@ -57,9 +57,9 @@ module Elasticsearch
       # @option arguments [String] :type Default document type for items which don't provide one
       # @option arguments [List] :fields Default comma-separated list of fields to return in the response for updates, can be overridden on each sub-request
       # @option arguments [List] :_source True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
-      # @option arguments [List] :_source_exclude Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
-      # @option arguments [List] :_source_include Default list of fields to extract and return from the _source field, can be overridden on each sub-request
-      # @option arguments [String] :pipeline The pipeline ID to preprocess incoming documents with
+      # @option arguments [List] :_source_excludes Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
+      # @option arguments [List] :_source_includes Default list of fields to extract and return from the _source field, can be overridden on each sub-request
+      # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
       #
       # @return [Hash] Deserialized Elasticsearch response
       #
@@ -96,9 +96,7 @@ module Elasticsearch
           :type,
           :fields,
           :_source,
-          :_source_exclude,
           :_source_excludes,
-          :_source_include,
           :_source_includes,
           :pipeline ].freeze)
     end

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

@@ -34,16 +34,15 @@ module Elasticsearch
         #     client.cat.aliases format: 'json'
         #
         # @option arguments [List] :name A comma-separated list of alias names to return
-        # @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-aliases.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-aliases.html
         #
         def aliases(arguments={})
           name = arguments.delete(:name)
@@ -59,12 +58,13 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:aliases, [
+            :format,
             :local,
             :master_timeout,
             :h,
             :help,
-            :v,
-            :s ].freeze)
+            :s,
+            :v ].freeze)
       end
     end
   end

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

@@ -30,17 +30,16 @@ module Elasticsearch
         #     client.cat.allocation format: 'json'
         #
         # @option arguments [List] :node_id A comma-separated list of node IDs or 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-allocation.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-allocation.html
         #
         def allocation(arguments={})
           node_id = arguments.delete(:node_id)
@@ -56,13 +55,14 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:allocation, [
+            :format,
             :bytes,
             :local,
             :master_timeout,
             :h,
             :help,
-            :v,
-            :s ].freeze)
+            :s,
+            :v ].freeze)
       end
     end
   end

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

@@ -26,16 +26,15 @@ module Elasticsearch
         #     client.cat.count format: 'json'
         #
         # @option arguments [List] :index A comma-separated list of index names to limit the returned information
-        # @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-count.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-count.html
         #
         def count(arguments={})
           index = arguments.delete(:index)
@@ -56,12 +55,13 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:count, [
+            :format,
             :local,
             :master_timeout,
             :h,
             :help,
-            :v,
-            :s ].freeze)
+            :s,
+            :v ].freeze)
       end
     end
   end

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

@@ -13,17 +13,18 @@ module Elasticsearch
         #
         #     client.cat.fielddata fields: 'title,body'
         #
-        # @option arguments [List] :fields A comma-separated list of fields to include in the output
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, m, g)
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
-        #                                   (default: false)
+        # @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)
+        # @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 [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
+        # @option arguments [List] :fields A comma-separated list of fields to return in the output
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-fielddata.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-fielddata.html
         #
         def fielddata(arguments={})
           fields = arguments.delete(:fields)
@@ -40,13 +41,14 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:fielddata, [
+            :format,
             :bytes,
             :local,
             :master_timeout,
             :h,
             :help,
-            :v,
             :s,
+            :v,
             :fields ].freeze)
       end
     end

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

@@ -17,17 +17,16 @@ module Elasticsearch
         #
         #     client.cat.health format: 'json'
         #
-        # @option arguments [Boolean] :ts Whether to display timestamp information
-        # @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] :ts Set to false to disable timestamping
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-health.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-health.html
         #
         def health(arguments={})
           method = HTTP_GET
@@ -43,13 +42,14 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:health, [
+            :format,
             :local,
             :master_timeout,
             :h,
             :help,
+            :s,
             :ts,
-            :v,
-            :s ].freeze)
+            :v ].freeze)
       end
     end
   end

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

@@ -6,8 +6,9 @@ module Elasticsearch
         # Help information for the Cat API
         #
         # @option arguments [Boolean] :help Return help information
+        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat.html
         #
         def help(arguments={})
           method = HTTP_GET
@@ -22,7 +23,8 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:help, [
-            :help ].freeze)
+            :help,
+            :s ].freeze)
       end
     end
   end

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

@@ -36,20 +36,18 @@ module Elasticsearch
         #     client.cat.indices format: 'json'
         #
         # @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, m, g)
-        # @option arguments [Boolean] :pri Limit the returned information on primary shards only (default: false)
-        # @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] :health A health status ("green", "yellow", or "red" to filter only indices
-        #                                    matching the specified health status (options: green, yellow, red)
-        # @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 [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 [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (options: green, yellow, red)
+        # @option arguments [Boolean] :help Return help information
+        # @option arguments [Boolean] :pri Set to true to return stats only for primary shards
+        # @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-indices.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-indices.html
         #
         def indices(arguments={})
           index = arguments.delete(:index)
@@ -69,15 +67,16 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:indices, [
+            :format,
             :bytes,
+            :local,
+            :master_timeout,
             :h,
             :health,
             :help,
-            :local,
-            :master_timeout,
             :pri,
-            :v,
-            :s ].freeze)
+            :s,
+            :v ].freeze)
       end
     end
   end

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

@@ -17,16 +17,15 @@ module Elasticsearch
         #
         #     client.cat.master 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-master.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-master.html
         #
         def master(arguments={})
           method = HTTP_GET
@@ -41,12 +40,13 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:master, [
+            :format,
             :local,
             :master_timeout,
             :h,
             :help,
-            :v,
-            :s ].freeze)
+            :s,
+            :v ].freeze)
       end
     end
   end

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

@@ -5,14 +5,15 @@ module Elasticsearch
 
         # Display 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
         # @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-nodeattrs.html
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodeattrs.html
         #
         def nodeattrs(arguments={})
           method = 'GET'
@@ -27,12 +28,13 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:nodeattrs, [
+            :format,
             :local,
             :master_timeout,
             :h,
             :help,
-            :v,
-            :s ].freeze)
+            :s,
+            :v ].freeze)
       end
     end
   end

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

@@ -25,17 +25,16 @@ module Elasticsearch
         #
         #     client.cat.nodes format: 'json'
         #
+        # @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)
-        # @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 [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-nodes.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-nodes.html
         #
         def nodes(arguments={})
           method = HTTP_GET
@@ -53,13 +52,14 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:nodes, [
+            :format,
             :full_id,
             :local,
             :master_timeout,
             :h,
             :help,
-            :v,
-            :s ].freeze)
+            :s,
+            :v ].freeze)
       end
     end
   end