elasticsearch-api 7.3.0 → 7.5.0

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

@@ -6,62 +6,66 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Return the mapping definition for specific field (or fields)
-        #
-        # @example Get mapping for a specific field across all indices
-        #
-        #     client.indices.get_field_mapping field: 'foo'
-        #
-        # @example Get mapping for a specific field in an index
-        #
-        #     client.indices.get_field_mapping index: 'foo', field: 'bar'
-        #
-        # @example Get mappings for multiple fields in an index
-        #
-        #     client.indices.get_field_mapping index: 'foo', field: ['bar', 'bam']
+        # Returns mapping for one or more fields.
         #
+        # @option arguments [List] :fields A comma-separated list of fields
         # @option arguments [List] :index A comma-separated list of index names
-        # @option arguments [List] :type A comma-separated list of document types
-        # @option arguments [List] :fields A comma-separated list of fields (*Required*)
+        # @option arguments [List] :type A comma-separated list of document types   *Deprecated*
         # @option arguments [Boolean] :include_type_name Whether a type should be returned in the body of the mappings.
         # @option arguments [Boolean] :include_defaults Whether the default mapping values should be returned as well
         # @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 [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-get-field-mapping.html
+        # *Deprecation notice*:
+        # Specifying types in urls has been deprecated
+        # Deprecated since version 7.0.0
         #
-        def get_field_mapping(arguments={})
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-get-field-mapping.html
+        #
+        def get_field_mapping(arguments = {})
+          _fields = arguments.delete(:field) || arguments.delete(:fields)
+          raise ArgumentError, "Required argument 'field' missing" unless _fields
+
           arguments = arguments.clone
-          fields = arguments.delete(:field) || arguments.delete(:fields)
-          raise ArgumentError, "Required argument 'field' missing" unless fields
-          method = HTTP_GET
-          path   = Utils.__pathify(
-                     Utils.__listify(arguments[:index]),
-                     '_mapping',
-                     Utils.__listify(arguments[:type]),
-                     'field',
-                     Utils.__listify(fields)
-                   )
+
+          _index = arguments.delete(:index)
+
+          _type = arguments.delete(:type)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index && _type && _fields
+                     "#{Utils.__listify(_index)}/_mapping/#{Utils.__listify(_type)}/field/#{Utils.__listify(_fields)}"
+                   elsif _index && _fields
+                     "#{Utils.__listify(_index)}/_mapping/field/#{Utils.__listify(_fields)}"
+                   elsif _type && _fields
+                     "_mapping/#{Utils.__listify(_type)}/field/#{Utils.__listify(_fields)}"
+                   else
+                     "_mapping/field/#{Utils.__listify(_fields)}"
+      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(:get_field_mapping, [
-            :include_type_name,
-            :include_defaults,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :local ].freeze)
+          :include_type_name,
+          :include_defaults,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :local
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,54 +6,62 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Return the mapping definitions for all indices, or specific indices/types.
-        #
-        # @example Get all mappings in the cluster
-        #
-        #     client.indices.get_mapping
-        #
-        # @example Get mapping for a specific index
-        #
-        #     client.indices.get_mapping index: 'foo'
-        #
-        # @example Get mapping for a specific type in a specific index
-        #
-        #     client.indices.get_mapping index: 'foo', type: 'baz'
+        # Returns mappings for one or more indices.
         #
         # @option arguments [List] :index A comma-separated list of index names
-        # @option arguments [List] :type A comma-separated list of document types
+        # @option arguments [List] :type A comma-separated list of document types   *Deprecated*
         # @option arguments [Boolean] :include_type_name Whether to add the type name to the response (default: false)
         # @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 [Time] :master_timeout Specify timeout for connection to master
         # @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-get-mapping.html
+        # *Deprecation notice*:
+        # Specifying types in urls has been deprecated
+        # Deprecated since version 7.0.0
         #
-        def get_mapping(arguments={})
-          method = HTTP_GET
-          path   = Utils.__pathify Utils.__listify(arguments[:index]),
-                                   '_mapping',
-                                   Utils.__listify(arguments[:type])
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-get-mapping.html
+        #
+        def get_mapping(arguments = {})
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          _type = arguments.delete(:type)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index && _type
+                     "#{Utils.__listify(_index)}/_mapping/#{Utils.__listify(_type)}"
+                   elsif _index
+                     "#{Utils.__listify(_index)}/_mapping"
+                   elsif _type
+                     "_mapping/#{Utils.__listify(_type)}"
+                   else
+                     "_mapping"
+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(:get_mapping, [
-            :include_type_name,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :master_timeout,
-            :local ].freeze)
+          :include_type_name,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :master_timeout,
+          :local
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,62 +6,59 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Return the settings for all indices, or a list of indices.
-        #
-        # @example Get settings for all indices
-        #
-        #     client.indices.get_settings
-        #
-        # @example Get settings for the 'foo' index
-        #
-        #     client.indices.get_settings index: 'foo'
-        #
-        # @example Get settings for indices beginning with foo
-        #
-        #     client.indices.get_settings prefix: 'foo'
-        #
-        # @example Get settings for an index named _myindex_
-        #
-        #     client.indices.get_settings index: 'myindex'
+        # Returns settings for 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 [List] :name The name of the settings that should be included
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @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 [Boolean] :flat_settings Return settings in flat format (default: false)
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (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-get-settings/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-get-settings.html
         #
-        def get_settings(arguments={})
-          method = HTTP_GET
-          path   = Utils.__pathify Utils.__listify(arguments[:index]),
-                                   Utils.__listify(arguments[:type]),
-                                   arguments.delete(:prefix),
-                                   '_settings',
-                                   Utils.__escape(arguments[:name])
+        def get_settings(arguments = {})
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index && _name
+                     "#{Utils.__listify(_index)}/_settings/#{Utils.__listify(_name)}"
+                   elsif _index
+                     "#{Utils.__listify(_index)}/_settings"
+                   elsif _name
+                     "_settings/#{Utils.__listify(_name)}"
+                   else
+                     "_settings"
+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(:get_settings, [
-            :master_timeout,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :flat_settings,
-            :local,
-            :include_defaults ].freeze)
+          :master_timeout,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :flat_settings,
+          :local,
+          :include_defaults
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,46 +6,44 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Get a single index template.
-        #
-        # @example Get all templates
-        #
-        #     client.indices.get_template
-        #
-        # @example Get a template named _mytemplate_
-        #
-        #     client.indices.get_template name: 'mytemplate'
-        #
-        # @note Use the {Cluster::Actions#state} API to get a list of all templates.
+        # Returns an index template.
         #
         # @option arguments [List] :name The comma separated names of the index templates
         # @option arguments [Boolean] :include_type_name Whether a type should be returned in the body of the mappings.
         # @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/reference/api/admin-indices-templates/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-templates.html
         #
-        def get_template(arguments={})
-          method = HTTP_GET
-          path   = Utils.__pathify '_template', Utils.__escape(arguments[:name])
+        def get_template(arguments = {})
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
 
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _name
+                     "_template/#{Utils.__listify(_name)}"
+                   else
+                     "_template"
+end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body]
 
+          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_template, [
-            :include_type_name,
-            :flat_settings,
-            :master_timeout,
-            :local ].freeze)
+          :include_type_name,
+          :flat_settings,
+          :master_timeout,
+          :local
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -0,0 +1,48 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+        # The _upgrade API is no longer useful and will be removed.
+        #
+        # @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] :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/en/elasticsearch/reference/7.5/indices-upgrade.html
+        #
+        def get_upgrade(arguments = {})
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_upgrade"
+                   else
+                     "_upgrade"
+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.2.0
+        ParamsRegistry.register(:get_upgrade, [
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards
+        ].freeze)
+end
+      end
+  end
+end

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

@@ -6,45 +6,48 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Open a previously closed index (see the {Indices::Actions#close} API).
-        #
-        # @example Open index named _myindex_
-        #
-        #     client.indices.open index: 'myindex'
+        # Opens an index.
         #
-        # @option arguments [List] :index A comma separated list of indices to open (*Required*)
+        # @option arguments [List] :index A comma separated list of indices to open
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @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 [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
+
         #
-        # @see https://www.elastic.co/guide/reference/api/admin-indices-open-close/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-open-close.html
         #
-        def open(arguments={})
+        def open(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-          method = HTTP_POST
-          path   = Utils.__pathify Utils.__escape(arguments[:index]), '_open'
 
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "#{Utils.__listify(_index)}/_open"
           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(:open, [
-            :timeout,
-            :master_timeout,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :wait_for_active_shards ].freeze)
+          :timeout,
+          :master_timeout,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :wait_for_active_shards
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -7,7 +7,6 @@ module Elasticsearch
     module Indices
       module Actions
         module ParamsRegistry
-
           extend self
 
           # A Mapping of all the actions to their list of valid params.

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

@@ -6,47 +6,45 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Create or update a single index alias.
-        #
-        # @example Create an alias for current month
-        #
-        #     client.indices.put_alias index: 'logs-2013-06', name: 'current-month'
-        #
-        # @example Create an alias for multiple indices
+        # Creates or updates an alias.
         #
-        #     client.indices.put_alias index: 'logs-2013-06', name: 'year-2013'
-        #     client.indices.put_alias index: 'logs-2013-05', name: 'year-2013'
-        #
-        # See the {Indices::Actions#update_aliases} for performing operations with index aliases in bulk.
-        #
-        # @option arguments [List] :index A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. (*Required*)
-        # @option arguments [String] :name The name of the alias to be created or updated (*Required*)
-        # @option arguments [Hash] :body The settings for the alias, such as `routing` or `filter`
+        # @option arguments [List] :index A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
+        # @option arguments [String] :name The name of the alias to be created or updated
         # @option arguments [Time] :timeout Explicit timestamp for the document
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
+
+        # @option arguments [Hash] :body The settings for the alias, such as `routing` or `filter`
         #
-        # @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 put_alias(arguments={})
-          raise ArgumentError, "Required argument 'index' missing"  unless arguments[:index]
-          raise ArgumentError, "Required argument 'name' missing"  unless arguments[:name]
-          method = HTTP_PUT
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_alias', Utils.__escape(arguments[:name])
+        def put_alias(arguments = {})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
 
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = if _index && _name
+                     "#{Utils.__listify(_index)}/_aliases/#{Utils.__listify(_name)}"
+  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(:put_alias, [
-            :timeout,
-            :master_timeout ].freeze)
+          :timeout,
+          :master_timeout
+        ].freeze)
+end
       end
-    end
   end
 end