elasticsearch-api 7.3.0 → 7.5.0

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

@@ -6,56 +6,44 @@ module Elasticsearch
   module API
     module Cluster
       module Actions
-
-        # Perform manual shard allocation in the cluster.
-        #
-        # Pass the operations you want to perform in the `:body` option. Use the `dry_run` option to
-        # evaluate the result of operations without actually performing them.
-        #
-        # @example Move shard `0` of index `myindex` from node named _Node1_ to node named _Node2_
+        # Allows to manually change the allocation of individual shards in the cluster.
         #
-        #     client.cluster.reroute body: {
-        #       commands: [
-        #         { move: { index: 'myindex', shard: 0, from_node: 'Node1', to_node: 'Node2' } }
-        #       ]
-        #     }
-        #
-        # @note If you want to explicitly set the shard allocation to a certain node, you might
-        #       want to look at the `allocation.*` cluster settings.
-        #
-        # @option arguments [Hash] :body The definition of `commands` to perform (`move`, `cancel`, `allocate`)
         # @option arguments [Boolean] :dry_run Simulate the operation only and return the resulting state
-        # @option arguments [Boolean] :explain Return an explanation for why the commands can or cannot be executed
-        # @option arguments [Boolean] :metric Limit the information returned to the specified metrics.
-        #                                     Defaults to all but metadata. (Options: _all, blocks, metadata,
-        #                                     nodes, routing_table, master_node, version)
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
-        # @option arguments [Boolean] :retry_failed Retries allocation of shards that are blocked due to too many
-        #                                           subsequent allocation failures
+        # @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
+        # @option arguments [List] :metric Limit the information returned to the specified metrics. Defaults to all but metadata
+        #   (options: _all,blocks,metadata,nodes,routing_table,master_node,version)
+
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Time] :timeout Explicit operation timeout
+
+        # @option arguments [Hash] :body The definition of `commands` to perform (`move`, `cancel`, `allocate`)
         #
-        # @see http://elasticsearch.org/guide/reference/api/admin-cluster-reroute/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-reroute.html
         #
-        def reroute(arguments={})
-          method = HTTP_POST
-          path   = "_cluster/reroute"
+        def reroute(arguments = {})
+          arguments = arguments.clone
 
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_cluster/reroute"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body] || {}
 
+          body = arguments[:body] || {}
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:reroute, [
-            :dry_run,
-            :explain,
-            :retry_failed,
-            :metric,
-            :master_timeout,
-            :timeout ].freeze)
+          :dry_run,
+          :explain,
+          :retry_failed,
+          :metric,
+          :master_timeout,
+          :timeout
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,64 +6,60 @@ module Elasticsearch
   module API
     module Cluster
       module Actions
-
-        # Get information about the cluster state (indices settings, allocations, etc)
-        #
-        # @example
-        #
-        #     client.cluster.state
+        # Returns a comprehensive information about the state of the cluster.
         #
-        # @option arguments [List] :index A comma-separated list of index names; use `_all` or omit to
-        #                                 perform the operation on all indices
         # @option arguments [List] :metric Limit the information returned to the specified metrics
-        #                                 (options: _all, blocks, index_templates, metadata, nodes, routing_table,
-        #                                  master_node, version)
-        # @option arguments [List] :index_templates A comma separated list to return specific index templates when
-        #                                           returning metadata
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
-        #                                    (default: false)
+        #   (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)
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
-        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression for inidices
-        #                                              (options: open, closed)
+        # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
+        # @option arguments [Number] :wait_for_metadata_version Wait for the metadata version to be equal or greater than the specified metadata version
+        # @option arguments [Time] :wait_for_timeout The maximum time to wait for wait_for_metadata_version before timing out
+        # @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)
-        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
-        #                                                 unavailable (missing, closed, etc)
+        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
+        #   (options: open,closed,none,all)
+
         #
-        # @see http://elasticsearch.org/guide/reference/api/admin-cluster-state/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-state.html
         #
-        def state(arguments={})
+        def state(arguments = {})
           arguments = arguments.clone
-          index     = arguments.delete(:index)
-          metric    = arguments.delete(:metric)
-          method = HTTP_GET
-          path   = Utils.__pathify '_cluster/state',
-                                   Utils.__listify(metric),
-                                   Utils.__listify(index)
 
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          _metric = arguments.delete(:metric)
 
-          [:index_templates].each do |key|
-            params[key] = Utils.__listify(params[key]) if params[key]
-          end
+          _index = arguments.delete(:index)
 
-          body = nil
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _metric && _index
+                     "_cluster/state/#{Utils.__listify(_metric)}/#{Utils.__listify(_index)}"
+                   elsif _metric
+                     "_cluster/state/#{Utils.__listify(_metric)}"
+                   else
+                     "_cluster/state"
+end
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
+          body = nil
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:state, [
-            :local,
-            :master_timeout,
-            :flat_settings,
-            :wait_for_metadata_version,
-            :wait_for_timeout,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards ].freeze)
+          :local,
+          :master_timeout,
+          :flat_settings,
+          :wait_for_metadata_version,
+          :wait_for_timeout,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,32 +6,40 @@ module Elasticsearch
   module API
     module Cluster
       module Actions
-
-        # Returns statistical information about the cluster
+        # 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 [Boolean] :human Whether to return time and byte values in human-readable format.
         # @option arguments [Time] :timeout Explicit operation timeout
+
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cluster-stats.html
         #
-        def stats(arguments={})
-          method = 'GET'
-          path   = "_cluster/stats"
+        def stats(arguments = {})
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _node_id
+                     "_cluster/stats/nodes/#{Utils.__listify(_node_id)}"
+                   else
+                     "_cluster/stats"
+end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
+          body = nil
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:stats, [
-            :flat_settings,
-            :timeout ].freeze)
+          :flat_settings,
+          :timeout
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -5,70 +5,83 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Get the number of documents for the cluster, index, type, or a query.
-      #
-      # @example Get the number of all documents in the cluster
-      #
-      #     client.count
-      #
-      # @example Get the number of documents in a specified index
-      #
-      #     client.count index: 'myindex'
-      #
-      # @example Get the number of documents matching a specific query
-      #
-      #     index: 'my_index', body: { filtered: { filter: { terms: { foo: ['bar'] } } } }
-      #
+      # Returns number of documents matching a query.
       #
       # @option arguments [List] :index A comma-separated list of indices to restrict the results
       # @option arguments [List] :type A comma-separated list of types to restrict the results
-      # @option arguments [Hash] :body A query to restrict the results specified with the Query DSL (optional)
       # @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
       # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
-      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
+      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
+      #   (options: open,closed,none,all)
+
       # @option arguments [Number] :min_score Include only documents with a specific `_score` value in the result
       # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
       # @option arguments [List] :routing A comma-separated list of specific routing values
       # @option arguments [String] :q Query in the Lucene query string syntax
       # @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)
-      # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
+      # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
+      #   (options: AND,OR)
+
       # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
       # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
       # @option arguments [Number] :terminate_after The maximum count for each shard, upon reaching which the query execution will terminate early
+
+      # @option arguments [Hash] :body A query to restrict the results specified with the Query DSL (optional)
+      #
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html
       #
-      def count(arguments={})
-        method = HTTP_GET
-        path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_count' )
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/search-count.html
+      #
+      def count(arguments = {})
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
 
+        _type = arguments.delete(:type)
+
+        method = if arguments[:body]
+                   Elasticsearch::API::HTTP_POST
+                 else
+                   Elasticsearch::API::HTTP_GET
+end
+
+        path = if _index && _type
+                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_count"
+               elsif _index
+                 "#{Utils.__listify(_index)}/_count"
+               else
+                 "_count"
+end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
 
+        body = arguments[:body]
         perform_request(method, path, params, body).body
       end
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.1.1
+      # @since 6.2.0
       ParamsRegistry.register(:count, [
-          :ignore_unavailable,
-          :ignore_throttled,
-          :allow_no_indices,
-          :expand_wildcards,
-          :min_score,
-          :preference,
-          :routing,
-          :q,
-          :analyzer,
-          :analyze_wildcard,
-          :default_operator,
-          :df,
-          :lenient,
-          :terminate_after ].freeze)
+        :ignore_unavailable,
+        :ignore_throttled,
+        :allow_no_indices,
+        :expand_wildcards,
+        :min_score,
+        :preference,
+        :routing,
+        :q,
+        :analyzer,
+        :analyze_wildcard,
+        :default_operator,
+        :df,
+        :lenient,
+        :terminate_after
+      ].freeze)
+    end
     end
-  end
 end

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

@@ -5,42 +5,41 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Create a new document.
-      #
-      # The API will create new document, if it doesn't exist yet -- in that case, it will return
-      # a `409` error (`version_conflict_engine_exception`).
-      #
-      # You can leave out the `:id` parameter for the ID to be generated automatically
-      #
-      # @example Create a document with an ID
+      # Creates a new document in the index.
       #
-      #     client.create index: 'myindex',
-      #                  type: 'doc',
-      #                  id: '1',
-      #                  body: {
-      #                   title: 'Test 1'
-      #                 }
+      # Returns a 409 response when a document with a same ID already exists in the index.
       #
-      # @example Create a document with an auto-generated ID
+      # @option arguments [String] :id Document ID
+      # @option arguments [String] :index The name of the index
+      # @option arguments [String] :type The type of the document   *Deprecated*
+      # @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)
+      # @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)
+
+      # @option arguments [String] :routing Specific routing value
+      # @option arguments [Time] :timeout Explicit operation timeout
+      # @option arguments [Number] :version Explicit version number for concurrency control
+      # @option arguments [String] :version_type Specific version type
+      #   (options: internal,external,external_gte)
+
+      # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
+
+      # @option arguments [Hash] :body The document (*Required*)
       #
-      #     client.create index: 'myindex',
-      #                  type: 'doc',
-      #                  body: {
-      #                   title: 'Test 1'
-      #                 }
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
       #
-      # @option (see Actions#index)
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html#_automatic_id_generation
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-index_.html
       #
-      def create(arguments={})
+      def create(arguments = {})
         if arguments[:id]
-          index arguments.update :op_type => 'create'
+          index arguments.update op_type: 'create'
         else
           index arguments
         end
       end
     end
-  end
+    end
 end

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

@@ -5,45 +5,52 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Delete a single document.
-      #
-      # @example Delete a document
-      #
-      #     client.delete index: 'myindex', type: 'mytype', id: '1'
-      #
-      # @example Delete a document with specific routing
+      # Removes a document from the index.
       #
-      #     client.delete index: 'myindex', type: 'mytype', id: '1', routing: 'abc123'
-      #
-      # @option arguments [String] :id The document ID (*Required*)
-      # @option arguments [String] :index The name of the index (*Required*)
-      # @option arguments [String] :type The type of the document
+      # @option arguments [String] :id The document ID
+      # @option arguments [String] :index The name of the index
+      # @option arguments [String] :type The type of the document   *Deprecated*
       # @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)
-      # @option arguments [String] :parent ID of parent document
-      # @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] :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)
+
       # @option arguments [String] :routing Specific routing value
       # @option arguments [Time] :timeout Explicit operation timeout
       # @option arguments [Number] :if_seq_no only perform the delete operation if the last operation that has changed the document has the specified sequence number
       # @option arguments [Number] :if_primary_term only perform the delete operation if the last operation that has changed the document has the specified primary term
       # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
+      # @option arguments [String] :version_type Specific version type
+      #   (options: internal,external,external_gte,force)
+
+      #
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
       #
-      # @see http://elasticsearch.org/guide/reference/api/delete/
       #
-      def delete(arguments={})
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-delete.html
+      #
+      def delete(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
-        arguments[:type] ||= DEFAULT_DOC
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+        arguments = arguments.clone
+
+        _id = arguments.delete(:id)
+
+        _index = arguments.delete(:index)
 
-        method = HTTP_DELETE
-        path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                 Utils.__escape(arguments[:type]),
-                                 Utils.__escape(arguments[:id])
+        _type = arguments.delete(:type)
 
+        method = Elasticsearch::API::HTTP_DELETE
+        path   = if _index && _type && _id
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}"
+                 else
+                   "#{Utils.__listify(_index)}/_doc/#{Utils.__listify(_id)}"
+  end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = nil
 
+        body = nil
         if Array(arguments[:ignore]).include?(404)
           Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
         else
@@ -53,17 +60,17 @@ module Elasticsearch
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.1.1
+      # @since 6.2.0
       ParamsRegistry.register(:delete, [
-          :wait_for_active_shards,
-          :parent,
-          :refresh,
-          :routing,
-          :timeout,
-          :if_seq_no,
-          :if_primary_term,
-          :version,
-          :version_type ].freeze)
+        :wait_for_active_shards,
+        :refresh,
+        :routing,
+        :timeout,
+        :if_seq_no,
+        :if_primary_term,
+        :version,
+        :version_type
+      ].freeze)
+    end
     end
-  end
 end