elasticsearch-api 6.8.0 → 7.10.0

data/lib/elasticsearch/api/actions/tasks/list.rb

@@ -1,9 +1,25 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module API
     module Tasks
       module Actions
-
-        # Return the list of tasks
+        # Returns a list of tasks.
         #
         # @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
         # @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all.
@@ -12,32 +28,35 @@ module Elasticsearch
         # @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)
         # @option arguments [String] :group_by Group tasks by nodes or parent/child relationships (options: nodes, parents, none)
         # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/tasks.html
         #
-        def list(arguments={})
+        def list(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
           arguments = arguments.clone
-          task_id = arguments.delete(:task_id)
 
-          method = 'GET'
-          path   = Utils.__pathify( '_tasks', Utils.__escape(task_id) )
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_tasks"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
-          perform_request(method, path, params, body).body
+          body = nil
+          perform_request(method, path, params, body, headers).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
         # @since 6.2.0
         ParamsRegistry.register(:list, [
-            :nodes,
-            :actions,
-            :detailed,
-            :parent_task_id,
-            :wait_for_completion,
-            :group_by,
-            :timeout ].freeze)
+          :nodes,
+          :actions,
+          :detailed,
+          :parent_task_id,
+          :wait_for_completion,
+          :group_by,
+          :timeout
+        ].freeze)
       end
     end
   end

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

@@ -1,14 +1,30 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module API
     module Tasks
       module Actions
         module ParamsRegistry
-
           extend self
 
           # A Mapping of all the actions to their list of valid params.
           #
-          # @since 6.2.0
+          # @since 6.1.1
           PARAMS = {}
 
           # Register an action with its list of valid params.
@@ -19,7 +35,7 @@ module Elasticsearch
           # @param [ Symbol ] action The action to register.
           # @param [ Array[Symbol] ] valid_params The list of valid params.
           #
-          # @since 6.2.0
+          # @since 6.1.1
           def register(action, valid_params)
             PARAMS[action.to_sym] = valid_params
           end
@@ -33,7 +49,7 @@ module Elasticsearch
           #
           # @return [ Array<Symbol> ] The list of valid params for the action.
           #
-          # @since 6.2.0
+          # @since 6.1.1
           def get(action)
             PARAMS.fetch(action, [])
           end

data/lib/elasticsearch/api/actions/termvectors.rb

@@ -1,46 +1,28 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module API
     module Actions
-
-      # Return information and statistics about terms in the fields of a particular document
-      #
-      # @example Get statistics for an indexed document
-      #
-      #     client.indices.create index: 'my_index',
-      #                           body: {
-      #                             mappings: {
-      #                               my_type: {
-      #                                 properties: {
-      #                                   text: {
-      #                                     type: 'string',
-      #                                     term_vector: 'with_positions_offsets_payloads'
-      #                                   }
-      #                                 }
-      #                               }
-      #                             }
-      #                           }
-      #
-      #     client.index index: 'my_index', type: 'my_type', id: '1', body: { text: 'Foo Bar Fox' }
-      #
-      #     client.termvectors index: 'my_index', type: 'my_type', id: '1'
-      #     # => { ..., "term_vectors" => { "text" => { "field_statistics" => { ... }, "terms" => { "bar" => ... } } }
-      #
-      #
-      # @example Get statistics for an arbitrary document
-      #
-      #     client.termvector index: 'my_index', type: 'my_type',
-      #                       body: {
-      #                         doc: {
-      #                           text: 'Foo Bar Fox'
-      #                         }
-      #                       }
-      #     # => { ..., "term_vectors" => { "text" => { "field_statistics" => { ... }, "terms" => { "bar" => ... } } }
-      #
+      # Returns information and statistics about terms in the fields of a particular document.
       #
       # @option arguments [String] :index The index in which the document resides. (*Required*)
-      # @option arguments [String] :type The type of the document. (*Required*)
       # @option arguments [String] :id The id of the document, when not specified a doc param should be supplied.
-      # @option arguments [Hash] :body Define parameters and or supply a document to get termvectors for. See documentation.
+      # @option arguments [String] :type The type of the document.
       # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned.
       # @option arguments [Boolean] :field_statistics Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.
       # @option arguments [List] :fields A comma-separated list of fields to return.
@@ -49,52 +31,76 @@ module Elasticsearch
       # @option arguments [Boolean] :payloads Specifies if term payloads should be returned.
       # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random).
       # @option arguments [String] :routing Specific routing value.
-      # @option arguments [String] :parent Parent id of documents.
       # @option arguments [Boolean] :realtime Specifies if request is real-time as opposed to near-real-time (default: true).
       # @option arguments [Number] :version Explicit version number for concurrency control
       # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body Define parameters and or supply a document to get termvectors for. See documentation.
       #
-      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-termvectors.html
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
       #
-      def termvectors(arguments={})
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-termvectors.html
+      #
+      def termvectors(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        raise ArgumentError, "Required argument 'type' missing" unless arguments[:type]
-        method = HTTP_GET
-        endpoint = arguments.delete(:endpoint) || '_termvectors'
 
-        path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                 Utils.__escape(arguments[:type]),
-                                 arguments[:id],
-                                 endpoint
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        _id = arguments.delete(:id)
+
+        _type = arguments.delete(:type)
+
+        method = if arguments[:body]
+                   Elasticsearch::API::HTTP_POST
+                 else
+                   Elasticsearch::API::HTTP_GET
+                 end
+
+        endpoint = arguments.delete(:endpoint) || '_termvectors'
+        path = if _index && _type && _id
+                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/#{endpoint}"
+               elsif _index && _type
+                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{endpoint}"
+               elsif _index && _id
+                 "#{Utils.__listify(_index)}/#{endpoint}/#{Utils.__listify(_id)}"
+               else
+                 "#{Utils.__listify(_index)}/#{endpoint}"
+               end
 
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
 
-        perform_request(method, path, params, body).body
+        body = arguments[:body]
+        perform_request(method, path, params, body, headers).body
       end
 
-      # @deprecated Use the plural version, {#termvectors}
+      # Deprecated: Use the plural version, {#termvectors}
       #
-      def termvector(arguments={})
-        termvectors(arguments.merge :endpoint => '_termvector')
+      def termvector(arguments = {})
+        termvectors(arguments.merge endpoint: '_termvector')
       end
-
       # Register this action with its valid params when the module is loaded.
       #
       # @since 6.2.0
       ParamsRegistry.register(:termvectors, [
-          :term_statistics,
-          :field_statistics,
-          :fields,
-          :offsets,
-          :positions,
-          :payloads,
-          :preference,
-          :routing,
-          :parent,
-          :realtime,
-          :version,
-          :version_type ].freeze)
+        :term_statistics,
+        :field_statistics,
+        :fields,
+        :offsets,
+        :positions,
+        :payloads,
+        :preference,
+        :routing,
+        :realtime,
+        :version,
+        :version_type
+      ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/update.rb

@@ -1,79 +1,78 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module API
     module Actions
-
-      # Update a document without sending the whole document in the request ("partial update").
-      #
-      # Send either a partial document (`doc` ) which will be deeply merged into an existing document,
-      # or a `script`, which will update the document content, in the `:body` argument.
-      #
-      # The partial update operation allows you to limit the amount of data you send over the wire and
-      # reduces the chance of failed updates due to conflict.
-      #
-      # Specify the `:version` and `:retry_on_conflict` arguments to balance convenience and consistency.
-      #
-      # @example Update document _title_ using partial `doc`-ument
-      #
-      #     client.update index: 'myindex', type: 'mytype', id: '1',
-      #                   body: { doc: { title: 'Updated' } }
-      #
-      # @example Add a tag to document `tags` property using a `script`
-      #
-      #     client.update index: 'myindex', type: 'mytype', id: '1',
-      #                    body: { script: { source: 'ctx._source.tags.add(params.tag)', params: { tag: 'x' } } }
-      #
-      # @example Increment a document counter by 1 _or_ initialize it, when the document does not exist
-      #
-      #     client.update index: 'myindex', type: 'mytype', id: '666',
-      #                   body: { script: 'ctx._source.counter += 1', upsert: { counter: 1 } }
-      #
-      # @example Delete a document if it's tagged "to-delete"
+      # Updates a document with a script or partial document.
       #
-      #     client.update index: 'myindex', type: 'mytype', id: '1',
-      #                   body: { script: 'ctx._source.tags.contains(params.tag) ? ctx.op = "delete" : ctx.op = "none"',
-      #                           params: { tag: 'to-delete' } }
-      #
-      #
-      # @option arguments [String] :id Document ID (*Required*)
-      # @option arguments [String] :index The name of the index (*Required*)
-      # @option arguments [String] :type The type of the document (*Required*)
-      # @option arguments [Hash] :body The request definition requires either `script` or partial `doc` (*Required*)
+      # @option arguments [String] :id Document ID
+      # @option arguments [String] :index The name of the index
+      # @option arguments [String] :type The type of the document *Deprecated*
       # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
-      # @option arguments [List] :fields A comma-separated list of fields to return in the response
       # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
       # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
       # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
       # @option arguments [String] :lang The script language (default: painless)
-      # @option arguments [String] :parent ID of the parent document. Is is only used for routing and when for the upsert request
-      # @option arguments [String] :refresh If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
+      # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
       # @option arguments [Number] :retry_on_conflict Specify how many times should the operation be retried when a conflict occurs (default: 0)
       # @option arguments [String] :routing Specific routing value
       # @option arguments [Time] :timeout Explicit operation timeout
-      # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type (options: internal, force)
-      # @since 0.20
+      # @option arguments [Number] :if_seq_no only perform the update operation if the last operation that has changed the document has the specified sequence number
+      # @option arguments [Number] :if_primary_term only perform the update operation if the last operation that has changed the document has the specified primary term
+      # @option arguments [Boolean] :require_alias When true, requires destination is an alias. Default is false
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body The request definition requires either `script` or partial `doc` (*Required*)
+      #
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
+      #
       #
-      # @see http://elasticsearch.org/guide/reference/api/update/
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-update.html
       #
-      def update(arguments={})
+      def update(arguments = {})
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
-        raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
-        method = HTTP_POST
-        path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                 Utils.__escape(arguments[:type]),
-                                 Utils.__escape(arguments[:id]),
-                                 '_update'
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        _id = arguments.delete(:id)
 
-        params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
+        _index = arguments.delete(:index)
+
+        _type = arguments.delete(:type)
+
+        method = Elasticsearch::API::HTTP_POST
+        path   = if _index && _type && _id
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/_update"
+                 else
+                   "#{Utils.__listify(_index)}/_update/#{Utils.__listify(_id)}"
+                 end
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
+        body = arguments[:body]
         if Array(arguments[:ignore]).include?(404)
-          Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
+          Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
         else
-          perform_request(method, path, params, body).body
+          perform_request(method, path, params, body, headers).body
         end
       end
 
@@ -81,22 +80,19 @@ module Elasticsearch
       #
       # @since 6.2.0
       ParamsRegistry.register(:update, [
-          :wait_for_active_shards,
-          :fields,
-          :_source,
-          :_source_excludes,
-          :_source_includes,
-          :lang,
-          :parent,
-          :refresh,
-          :retry_on_conflict,
-          :routing,
-          :timeout,
-          :version,
-          :version_type,
-          :if_seq_no,
-          :include_type_name,
-          :if_primary_term ].freeze)
+        :wait_for_active_shards,
+        :_source,
+        :_source_excludes,
+        :_source_includes,
+        :lang,
+        :refresh,
+        :retry_on_conflict,
+        :routing,
+        :timeout,
+        :if_seq_no,
+        :if_primary_term,
+        :require_alias
+      ].freeze)
     end
   end
 end