elasticsearch-api 7.4.0 → 7.5.0.pre.pre

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

@@ -6,39 +6,44 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Return true if the specified index template exists, false otherwise.
-        #
-        #     client.indices.exists_template? name: 'mytemplate'
+        # Returns information about whether a particular index template exists.
         #
-        # @option arguments [String] :name The name of the template (*Required*)
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+        # @option arguments [List] :name The comma separated names of the index templates
+        # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-templates.html
         #
-        def exists_template(arguments={})
+        def exists_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
-          method = HTTP_HEAD
-          path   = Utils.__pathify '_template', Utils.__escape(arguments[:name])
 
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_HEAD
+          path   = "_template/#{Utils.__listify(_name)}"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
           body = nil
 
           Utils.__rescue_from_not_found do
             perform_request(method, path, params, body).status == 200 ? true : false
           end
         end
-        alias_method :exists_template?, :exists_template
 
+        alias_method :exists_template?, :exists_template
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:exists_template, [
-            :flat_settings,
-            :master_timeout,
-            :local ].freeze)
+          :flat_settings,
+          :master_timeout,
+          :local
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,52 +6,52 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Return true if the specified type exists, false otherwise.
-        #
-        #     client.indices.exists_type? index: 'myindex', type: 'mytype'
+        # Returns information about whether a particular document type exists. (DEPRECATED)
         #
-        # @option arguments [List] :index A comma-separated list of index names; use `_all`
-        #                                 to check the types across all indices (*Required*)
-        # @option arguments [List] :type A comma-separated list of document types to check (*Required*)
-        # @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)
-        # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
-        #                                            `missing` ones (options: none, missing) @until 1.0
-        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
-        #                                                 unavailable (missing, closed, etc)
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
-        #                                    (default: false)
+        # @option arguments [List] :index A comma-separated list of index names; use `_all` to check the types across all indices
+        # @option arguments [List] :type A comma-separated list of document types to check
+        # @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 [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
+        #   (options: open,closed,none,all)
+
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-types-exists.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-types-exists.html
         #
-        def exists_type(arguments={})
+        def exists_type(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
           raise ArgumentError, "Required argument 'type' missing" unless arguments[:type]
-          method = HTTP_HEAD
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_mapping', Utils.__escape(arguments[:type])
 
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          _type = arguments.delete(:type)
+
+          method = Elasticsearch::API::HTTP_HEAD
+          path   = "#{Utils.__listify(_index)}/_mapping/#{Utils.__listify(_type)}"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
           body = nil
 
           Utils.__rescue_from_not_found do
             perform_request(method, path, params, body).status == 200 ? true : false
           end
         end
-        alias_method :exists_type?, :exists_type
 
+        alias_method :exists_type?, :exists_type
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:exists_type, [
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :local ].freeze)
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :local
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,47 +6,47 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # "Flush" the index or indices.
-        #
-        # The "flush" operation clears the transaction log and memory and writes data to disk.
-        # It corresponds to a Lucene "commit" operation.
-        #
-        # @note The flush operation is handled automatically by Elasticsearch, you don't need to perform it manually.
+        # Performs the flush operation on one or more indices.
         #
         # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string for all indices
-        # @option arguments [Boolean] :force Whether a flush should be forced even if it is not necessarily needed ie.
-        # @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)
-        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
-        #                                                 unavailable (missing, closed, etc)
-        # @option arguments [Boolean] :wait_if_ongoing If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped if another flush operation is already running. (Default: true)
+        # @option arguments [Boolean] :force Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
+        # @option arguments [Boolean] :wait_if_ongoing If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running.
+        # @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 [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
+        #   (options: open,closed,none,all)
+
         #
-        # @see https://www.elastic.co/guide/reference/api/admin-indices-flush/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-flush.html
         #
-        def flush(arguments={})
-          method = HTTP_POST
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_flush'
+        def flush(arguments = {})
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
 
+          method = Elasticsearch::API::HTTP_POST
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_flush"
+                   else
+                     "_flush"
+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(:flush, [
-            :force,
-            :wait_if_ongoing,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards ].freeze)
+          :force,
+          :wait_if_ongoing,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,21 +6,31 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
+        # Performs a synced flush operation on one or more indices.
+        #
         # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string for all indices
         # @option arguments [Boolean] :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 [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)
+
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-synced-flush-api.html
         #
-        def flush_synced(arguments={})
-          method = HTTP_POST
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_flush/synced'
+        def flush_synced(arguments = {})
+          arguments = arguments.clone
 
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_flush/synced"
+                   else
+                     "_flush/synced"
+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
@@ -30,12 +40,13 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:flush_synced, [
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards ].freeze)
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,65 +6,50 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Force merge an index, list of indices, or all indices in the cluster.
-        #
-        # @example Fully force merge an index
-        #
-        #     client.indices.forcemerge index: 'foo', max_num_segments: 1
-        #
-        # @example Do not flush index after force-merging
-        #
-        #     client.indices.forcemerge index: 'foo', flush: false
-        #
-        # @example Do not expunge deleted documents after force-merging
-        #
-        #     client.indices.forcemerge index: 'foo', only_expunge_deletes: false
-        #
-        # @example Force merge a list of indices
-        #
-        #     client.indices.forcemerge index: ['foo', 'bar']
-        #     client.indices.forcemerge index: 'foo,bar'
-        #
-        # @example forcemerge a list of indices matching wildcard expression
-        #
-        #     client.indices.forcemerge index: 'foo*'
-        #
-        # @example forcemerge all indices
-        #
-        #     client.indices.forcemerge index: '_all'
+        # Performs the force merge operation on one or more indices.
         #
         # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
         # @option arguments [Boolean] :flush Specify whether the index should be flushed after performing the operation (default: true)
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @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] :max_num_segments The number of segments the index should be merged into (default: dynamic)
         # @option arguments [Boolean] :only_expunge_deletes Specify whether the operation should only expunge deleted documents
+
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-forcemerge.html
         #
-        def forcemerge(arguments={})
-          method = HTTP_POST
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_forcemerge'
+        def forcemerge(arguments = {})
+          arguments = arguments.clone
 
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_forcemerge"
+                   else
+                     "_forcemerge"
+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(:forcemerge, [
-            :flush,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :max_num_segments,
-            :only_expunge_deletes ].freeze)
+          :flush,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :max_num_segments,
+          :only_expunge_deletes
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -2,7 +2,6 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
         # In order to keep indices available and queryable for a longer period but at the same time reduce their
         #   hardware requirements they can be transitioned into a frozen state. Once an index is frozen, all of its
         #   transient shard memory (aside from mappings and analyzers) is moved to persistent storage.
@@ -17,12 +16,13 @@ module Elasticsearch
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
           valid_params = [
-              :timeout,
-              :master_timeout,
-              :ignore_unavailable,
-              :allow_no_indices,
-              :expand_wildcards,
-              :wait_for_active_shards]
+            :timeout,
+            :master_timeout,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards,
+            :wait_for_active_shards
+          ]
 
           arguments = arguments.clone
           index = arguments.delete(:index)
@@ -37,4 +37,3 @@ module Elasticsearch
     end
   end
 end
-

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

@@ -6,46 +6,52 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Retrieve information about one or more indices
+        # Returns information about one or more indices.
         #
-        # @option arguments [List] :index A comma-separated list of index names (*Required*)
+        # @option arguments [List] :index A comma-separated list of index names
         # @option arguments [Boolean] :include_type_name Whether to add the type name to the response (default: false)
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false)
         # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false)
-        # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, none, all)
+        # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open)
+        #   (options: open,closed,none,all)
+
         # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
         # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices.
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-get-index.html
         #
-        def get(arguments={})
+        def get(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-          method = HTTP_GET
 
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), Utils.__listify(arguments.delete(:feature))
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
 
+          method = Elasticsearch::API::HTTP_GET
+          path   = "#{Utils.__listify(_index)}"
           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(:get, [
-            :include_type_name,
-            :local,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :flat_settings,
-            :include_defaults,
-            :master_timeout  ].freeze)
+          :include_type_name,
+          :local,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :flat_settings,
+          :include_defaults,
+          :master_timeout
+        ].freeze)
+end
       end
-    end
   end
 end