elasticsearch-api 7.3.0 → 7.5.0

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

@@ -6,63 +6,64 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Create or update mapping.
-        #
-        # Pass the mapping definition(s) in the `:body` argument.
-        #
-        # @example Create or update a mapping for a specific document type
-        #
-        #     client.indices.put_mapping index: 'myindex', type: 'mytype', body: {
-        #       mytype: {
-        #         properties: {
-        #           title: { type: 'text', analyzer: 'snowball' }
-        #         }
-        #       }
-        #     }
-        #
-        # @example Update the mapping for a specific type in all indices
-        #
-        #     client.indices.put_mapping type: 'mytype', body: {
-        #       mytype: {
-        #         dynamic: 'strict'
-        #       }
-        #     }
+        # Updates the index mappings.
         #
         # @option arguments [List] :index A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
-        # @option arguments [String] :type The name of the document type
-        # @option arguments [Hash] :body The mapping definition (*Required*)
+        # @option arguments [String] :type The name of the document type   *Deprecated*
         # @option arguments [Boolean] :include_type_name Whether a type should be expected in the body of the mappings.
         # @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 [Hash] :body The mapping definition (*Required*)
+        #
+        # *Deprecation notice*:
+        # Specifying types in urls has been deprecated
+        # Deprecated since version 7.0.0
         #
-        # @see https://www.elastic.co/guide/reference/api/admin-indices-put-mapping/
         #
-        def put_mapping(arguments={})
-          raise ArgumentError, "Required argument 'body' missing"  unless arguments[:body]
-          method = HTTP_PUT
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_mapping', Utils.__escape(arguments[:type])
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-put-mapping.html
+        #
+        def put_mapping(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
 
+          _index = arguments.delete(:index)
+
+          _type = arguments.delete(:type)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = if _index && _type
+                     "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_mappings"
+                   elsif _type
+                     "_mappings/#{Utils.__listify(_type)}"
+                   elsif _index
+                     "#{Utils.__listify(_index)}/_mappings"
+                   else
+                     "_mapping/#{Utils.__listify(_type)}"
+  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_mapping, [
-            :include_type_name,
-            :timeout,
-            :master_timeout,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards ].freeze)
+          :include_type_name,
+          :timeout,
+          :master_timeout,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,62 +6,55 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Update the settings for one or multiple indices.
-        #
-        # @example Change the number of replicas for all indices
-        #
-        #     client.indices.put_settings body: { index: { number_of_replicas: 0 } }
-        #
-        #
-        # @example Change the number of replicas for a specific index
-        #
-        #     client.indices.put_settings index: 'myindex', body: { index: { number_of_replicas: 0 } }
-        #
-        #
-        # @example Disable "flush" for all indices
-        #
-        #     client.indices.put_settings body: { 'index.translog.disable_flush' => true }
-        #
-        # @example Allocate specific index on specific nodes
-        #
-        #     client.indices.put_settings index: 'my-big-index',
-        #                                 body: { 'index.routing.allocation.require.tag' => 'bigbox' }
+        # Updates the index settings.
         #
         # @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 [Hash] :body The index settings to be updated (*Required*)
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Boolean] :preserve_existing Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `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 [Boolean] :flat_settings Return settings in flat format (default: false)
+
+        # @option arguments [Hash] :body The index settings to be updated (*Required*)
         #
-        # @see https://www.elastic.co/guide/reference/api/admin-indices-update-settings/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-update-settings.html
         #
-        def put_settings(arguments={})
+        def put_settings(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-          method = HTTP_PUT
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_settings'
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_settings"
+                   else
+                     "_settings"
+  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_settings, [
-            :master_timeout,
-            :timeout,
-            :preserve_existing,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :flat_settings ].freeze)
+          :master_timeout,
+          :timeout,
+          :preserve_existing,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :flat_settings
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,48 +6,48 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Create or update an index template.
-        #
-        # @example Create a template for all indices starting with `logs-`
-        #
-        #     client.indices.put_template name: 'foo',
-        #                                 body: { template: 'logs-*', settings: { 'index.number_of_shards' => 1 } }
+        # Creates or updates an index template.
         #
-        # @option arguments [String] :name The name of the template (*Required*)
-        # @option arguments [Hash] :body The template definition (*Required*)
+        # @option arguments [String] :name The name of the template
         # @option arguments [Boolean] :include_type_name Whether a type should be returned in the body of the mappings.
         # @option arguments [Number] :order The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
         # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
+
+        # @option arguments [Hash] :body The template definition (*Required*)
         #
-        # @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 put_template(arguments={})
-          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+        def put_template(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-          method = HTTP_PUT
-          path   = Utils.__pathify '_template', Utils.__escape(arguments[:name])
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+          arguments = arguments.clone
 
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_template/#{Utils.__listify(_name)}"
           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_template, [
-            :include_type_name,
-            :order,
-            :create,
-            :timeout,
-            :master_timeout,
-            :flat_settings ].freeze)
+          :include_type_name,
+          :order,
+          :create,
+          :timeout,
+          :master_timeout,
+          :flat_settings
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,43 +6,40 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Return information about shard recovery for one or more indices
-        #
-        # @example Get recovery information for a single index
-        #
-        #     client.indices.recovery index: 'foo'
-        #
-        # @example Get detailed recovery information for multiple indices
-        #
-        #     client.indices.recovery index: ['foo', 'bar'], detailed: true
-        #
-        # @example Get recovery information for all indices
-        #
-        #     client.indices.recovery
+        # Returns information about ongoing index shard recoveries.
         #
         # @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] :detailed Whether to display detailed information about shard recovery
         # @option arguments [Boolean] :active_only Display only those recoveries that are currently on-going
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-recovery.html
         #
-        def recovery(arguments={})
-          method = HTTP_GET
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_recovery'
+        def recovery(arguments = {})
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_recovery"
+                   else
+                     "_recovery"
+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(:recovery, [
-            :detailed,
-            :active_only  ].freeze)
+          :detailed,
+          :active_only
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,47 +6,43 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Refresh the index and to make the changes (creates, updates, deletes) searchable.
-        #
-        # By default, Elasticsearch has a delay of 1 second until changes to an index are
-        # available for search; the delay is configurable, see {Indices::Actions#put_settings}.
-        #
-        # You can trigger this operation explicitly, for example when performing a sequence of commands
-        # in integration tests, or when you need to perform a manual "synchronization" of the index
-        # with an external system at given moment.
-        #
-        # @example Refresh an index named _myindex_
-        #
-        #     client.indices.refresh index: 'myindex'
-        #
-        # @note The refresh operation can adversely affect indexing throughput when used too frequently.
+        # Performs the refresh operation in 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] :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 https://www.elastic.co/guide/reference/api/admin-indices-refresh/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-refresh.html
         #
-        def refresh(arguments={})
-          method = HTTP_POST
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_refresh'
+        def refresh(arguments = {})
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
 
+          method = Elasticsearch::API::HTTP_POST
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_refresh"
+                   else
+                     "_refresh"
+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(:refresh, [
-            :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/rollover.rb

@@ -6,44 +6,53 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # The rollover index API rolls an alias over to a new index when the existing index
-        # is considered to be too large or too old
+        # Updates an alias to point to a new index when the existing index
+        # is considered to be too large or too old.
         #
-        # @option arguments [String] :alias The name of the alias to rollover (*Required*)
+        # @option arguments [String] :alias The name of the alias to rollover
         # @option arguments [String] :new_index The name of the rollover index
-        # @option arguments [Hash] :body The conditions that needs to be met for executing rollover
         # @option arguments [Boolean] :include_type_name Whether a type should be included in the body of the mappings.
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Boolean] :dry_run If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the newly created rollover index before the operation returns.
+
+        # @option arguments [Hash] :body The conditions that needs to be met for executing rollover
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-index.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-rollover-index.html
         #
-        def rollover(arguments={})
+        def rollover(arguments = {})
           raise ArgumentError, "Required argument 'alias' missing" unless arguments[:alias]
+
           arguments = arguments.clone
-          source = arguments.delete(:alias)
-          target = arguments.delete(:new_index)
-          method = HTTP_POST
-          path   = Utils.__pathify Utils.__escape(source), '_rollover', Utils.__escape(target)
+
+          _alias = arguments.delete(:alias)
+
+          _new_index = arguments.delete(:new_index)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = if _alias && _new_index
+                     "#{Utils.__listify(_alias)}/_rollover/#{Utils.__listify(_new_index)}"
+                   else
+                     "#{Utils.__listify(_alias)}/_rollover"
+  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(:rollover, [
-            :include_type_name,
-            :timeout,
-            :dry_run,
-            :master_timeout,
-            :wait_for_active_shards ].freeze)
+          :include_type_name,
+          :timeout,
+          :dry_run,
+          :master_timeout,
+          :wait_for_active_shards
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,39 +6,46 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Return information about segments for one or more indices.
-        #
-        # The response contains information about segment size, number of documents, deleted documents, etc.
-        # See also {Indices::Actions#optimize}.
+        # Provides low-level information about segments in a Lucene index.
         #
         # @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)
+        # @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] :verbose Includes detailed memory usage by Lucene.
+
         #
-        # @see http://elasticsearch.org/guide/reference/api/admin-indices-segments/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-segments.html
         #
-        def segments(arguments={})
-          method = HTTP_GET
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_segments'
+        def segments(arguments = {})
+          arguments = arguments.clone
 
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_segments"
+                   else
+                     "_segments"
+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(:segments, [
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :verbose ].freeze)
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :verbose
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,35 +6,47 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Provides low-level information about shards (allocated nodes, exceptions, ...)
+        # Provides store information for shard copies of 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] :status A comma-separated list of statuses used to filter on shards to get store information for (options: green, yellow, red, all)
+        # @option arguments [List] :status A comma-separated list of statuses used to filter on shards to get store information for
+        #   (options: green,yellow,red,all)
+
         # @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-shards-stores.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-shards-stores.html
         #
-        def shard_stores(arguments={})
-          method = 'GET'
-          path   = Utils.__pathify Utils.__escape(arguments[:index]), "_shard_stores"
+        def shard_stores(arguments = {})
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_shard_stores"
+                   else
+                     "_shard_stores"
+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(:shard_stores, [
-            :status,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards ].freeze)
+          :status,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards
+        ].freeze)
+end
       end
-    end
   end
 end