lib/elasticsearch/api/actions/indices/put_template.rb in elasticsearch-api-7.4.0 vs lib/elasticsearch/api/actions/indices/put_template.rb in elasticsearch-api-7.5.0.pre.pre

- old
+ new

@@ -4,50 +4,50 @@ module Elasticsearch module API module Indices module Actions - - # Create or update an index template. + # Creates or updates 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 } } - # - # @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