elasticsearch-api 7.4.0 → 7.5.0.pre.pre

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

@@ -6,91 +6,43 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Create an index.
-        #
-        # Pass the index `settings` and `mappings` in the `:body` attribute.
-        #
-        # @example Create an index with specific settings, custom analyzers and mappings
-        #
-        #     client.indices.create index: 'test',
-        #                           body: {
-        #                             settings: {
-        #                               index: {
-        #                                 number_of_shards: 1,
-        #                                 number_of_replicas: 0,
-        #                                 'routing.allocation.include.name' => 'node-1'
-        #                               },
-        #                               analysis: {
-        #                                 filter: {
-        #                                   ngram: {
-        #                                     type: 'nGram',
-        #                                     min_gram: 3,
-        #                                     max_gram: 25
-        #                                   }
-        #                                 },
-        #                                 analyzer: {
-        #                                   ngram: {
-        #                                     tokenizer: 'whitespace',
-        #                                     filter: ['lowercase', 'stop', 'ngram'],
-        #                                     type: 'custom'
-        #                                   },
-        #                                   ngram_search: {
-        #                                     tokenizer: 'whitespace',
-        #                                     filter: ['lowercase', 'stop'],
-        #                                     type: 'custom'
-        #                                   }
-        #                                 }
-        #                               }
-        #                             },
-        #                             mappings: {
-        #                               properties: {
-        #                                 title: {
-        #                                   type: 'multi_field',
-        #                                   fields: {
-        #                                       title:  { type: 'string', analyzer: 'snowball' },
-        #                                       exact:  { type: 'string', analyzer: 'keyword' },
-        #                                       ngram:  { type: 'string',
-        #                                                 index_analyzer: 'ngram',
-        #                                                 search_analyzer: 'ngram_search'
-        #                                       }
-        #                                   }
-        #                                 }
-        #                               }
-        #                             }
-        #                           }
+        # Creates an index with optional settings and mappings.
         #
-        # @option arguments [String] :index The name of the index (*Required*)
-        # @option arguments [Hash] :body Optional configuration for the index (`settings` and `mappings`)
+        # @option arguments [String] :index The name of the index
         # @option arguments [Boolean] :include_type_name Whether a type should be expected in the body of the mappings.
-        # @option arguments [Boolean] :update_all_types Whether to update the mapping for all fields
-        #                                               with the same name across all types
-        # @option arguments [Number] :wait_for_active_shards Wait until the specified number of shards is active
+        # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for before the operation returns.
         # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Boolean] :master_timeout Timeout for connection to master
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+
+        # @option arguments [Hash] :body The configuration for the index (`settings` and `mappings`)
         #
-        # @see https://www.elastic.co/guide/reference/api/admin-indices-create-index/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-create-index.html
         #
-        def create(arguments={})
+        def create(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-          method = HTTP_PUT
-          path   = Utils.__pathify Utils.__escape(arguments[:index])
 
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "#{Utils.__listify(_index)}"
           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(:create, [
-            :include_type_name,
-            :wait_for_active_shards,
-            :timeout,
-            :master_timeout ].freeze)
+          :include_type_name,
+          :wait_for_active_shards,
+          :timeout,
+          :master_timeout
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,44 +6,31 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Delete an index, list of indices, or all indices in the cluster.
-        #
-        # @example Delete an index
-        #
-        #     client.indices.delete index: 'foo'
-        #
-        # @example Delete a list of indices
-        #
-        #     client.indices.delete index: ['foo', 'bar']
-        #     client.indices.delete index: 'foo,bar'
-        #
-        #
-        # @example Delete a list of indices matching wildcard expression
+        # Deletes an index.
         #
-        #     client.indices.delete index: 'foo*'
-        #
-        # @example Delete all indices
-        #
-        #     client.indices.delete index: '_all'
-        #
-        # @option arguments [List] :index A comma-separated list of indices to delete;
-        #                                 use `_all` to delete all indices
+        # @option arguments [List] :index A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @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 [List] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (options: open, closed, none, all) (default: open)
+        # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open)
+        #   (options: open,closed,none,all)
+
         #
-        # @see https://www.elastic.co/guide/reference/api/admin-indices-delete-index/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-delete-index.html
         #
-        def delete(arguments={})
-          method = HTTP_DELETE
-          path   = Utils.__pathify Utils.__listify(arguments[:index])
+        def delete(arguments = {})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "#{Utils.__listify(_index)}"
           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,14 +40,15 @@ 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, [
-            :timeout,
-            :master_timeout,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards ].freeze)
+          :timeout,
+          :master_timeout,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,40 +6,44 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Delete a single index alias.
-        #
-        # @example Delete an alias
-        #
-        #     client.indices.delete_alias index: 'foo', name: 'bar'
+        # Deletes an alias.
         #
-        # See the {Indices::Actions#update_aliases} for performing operations with index aliases in bulk.
-        #
-        # @option arguments [String] :index The name of the index with an alias (*Required*)
-        # @option arguments [String] :name The name of the alias to be deleted (*Required*)
+        # @option arguments [List] :index A comma-separated list of index names (supports wildcards); use `_all` for all indices
+        # @option arguments [List] :name A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
         # @option arguments [Time] :timeout Explicit timestamp for the document
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+
         #
-        # @see https://www.elastic.co/guide/reference/api/admin-indices-aliases/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-aliases.html
         #
-        def delete_alias(arguments={})
+        def delete_alias(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-          raise ArgumentError, "Required argument 'name' missing"  unless arguments[:name]
-          method = HTTP_DELETE
-          path   = Utils.__pathify Utils.__escape(arguments[:index]), '_alias', Utils.__escape(arguments[:name])
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = if _index && _name
+                     "#{Utils.__listify(_index)}/_aliases/#{Utils.__listify(_name)}"
+  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(:delete_alias, [
-            :timeout,
-            :master_timeout ].freeze)
+          :timeout,
+          :master_timeout
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,30 +6,27 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Delete an index template.
-        #
-        # @example Delete a template named _mytemplate_
-        #
-        #     client.indices.delete_template name: 'mytemplate'
+        # Deletes an index template.
         #
-        # @example Delete all templates
-        #
-        #     client.indices.delete_template name: '*'
-        #
-        # @option arguments [String] :name The name of the template (*Required*)
+        # @option arguments [String] :name The name of the template
         # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+
         #
-        # @see https://www.elastic.co/guide/reference/api/admin-indices-templates/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-templates.html
         #
-        def delete_template(arguments={})
+        def delete_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
-          method = HTTP_DELETE
-          path   = Utils.__pathify '_template', Utils.__escape(arguments[:name])
 
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_template/#{Utils.__listify(_name)}"
           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
@@ -39,11 +36,12 @@ 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_template, [
-            :timeout,
-            :master_timeout ].freeze)
+          :timeout,
+          :master_timeout
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,54 +6,52 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Return true if the index (or all indices in a list) exists, false otherwise.
-        #
-        # @example Check whether index named _myindex_ exists
-        #
-        #     client.indices.exists? index: 'myindex'
-        #
-        # @option arguments [List] :index A comma-separated list of indices 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)
+        # Returns information about whether a particular index exists.
         #
-        # @return [true,false]
+        # @option arguments [List] :index A comma-separated list of index names
+        # @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 [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.
+
         #
-        # @see https://www.elastic.co/guide/reference/api/admin-indices-indices-exists/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-exists.html
         #
-        def exists(arguments={})
+        def exists(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-          method = HTTP_HEAD
-          path   = Utils.__listify(arguments[:index])
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_HEAD
+          path   = "#{Utils.__listify(_index)}"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
+
+          body = nil
 
           Utils.__rescue_from_not_found do
             perform_request(method, path, params, body).status == 200 ? true : false
           end
         end
-        alias_method :exists?, :exists
 
+        alias_method :exists?, :exists
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:exists, [
-            :local,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :flat_settings,
-            :include_defaults ].freeze)
+          :local,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :flat_settings,
+          :include_defaults
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,51 +6,55 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Return true if the specified alias exists, false otherwise.
-        #
-        # @example Check whether index alias named _myalias_ exists
+        # Returns information about whether a particular alias exists.
         #
-        #     client.indices.exists_alias? name: 'myalias'
-        #
-        # @option arguments [List] :index A comma-separated list of index names to filter aliases
         # @option arguments [List] :name A comma-separated list of alias names to return
-        # @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 to filter aliases
+        # @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/reference/api/admin-indices-aliases/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-aliases.html
         #
-        def exists_alias(arguments={})
-          method = HTTP_HEAD
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_alias', Utils.__escape(arguments[:name])
+        def exists_alias(arguments = {})
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+          arguments = arguments.clone
 
+          _name = arguments.delete(:name)
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_HEAD
+          path   = if _index && _name
+                     "#{Utils.__listify(_index)}/_alias/#{Utils.__listify(_name)}"
+                   else
+                     "_alias/#{Utils.__listify(_name)}"
+  end
           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_alias?, :exists_alias
 
+        alias_method :exists_alias?, :exists_alias
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:exists_alias, [
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :local ].freeze)
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :local
+        ].freeze)
+end
       end
-    end
   end
 end