elasticsearch-api 8.18.0 → 9.0.1

data/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb

@@ -15,25 +15,26 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Synonyms
       module Actions
-        # Retrieves a synonym rule from a synonym set
+        # Get a synonym rule.
+        # Get a synonym rule from a synonym set.
         #
-        # @option arguments [String] :set_id The id of the synonym set to retrieve the synonym rule from
-        # @option arguments [String] :rule_id The id of the synonym rule to retrieve
+        # @option arguments [String] :set_id The ID of the synonym set to retrieve the synonym rule from. (*Required*)
+        # @option arguments [String] :rule_id The ID of the synonym rule to retrieve. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-synonym-rule.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-get-synonym-rule
         #
         def get_synonym_rule(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'synonyms.get_synonym_rule' }
 
-          defined_params = %i[set_id rule_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:set_id, :rule_id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -51,7 +52,7 @@ module Elasticsearch
           _rule_id = arguments.delete(:rule_id)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "_synonyms/#{Utils.__listify(_set_id)}/#{Utils.__listify(_rule_id)}"
+          path   = "_synonyms/#{Utils.listify(_set_id)}/#{Utils.listify(_rule_id)}"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb

@@ -15,20 +15,21 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Synonyms
       module Actions
-        # Retrieves a summary of all defined synonym sets
+        # Get all synonym sets.
+        # Get a summary of all defined synonym sets.
         #
-        # @option arguments [Integer] :from Starting offset
-        # @option arguments [Integer] :size specifies a max number of results to get
+        # @option arguments [Integer] :from The starting offset for synonyms sets to retrieve. Server default: 0.
+        # @option arguments [Integer] :size The maximum number of synonyms sets to retrieve. Server default: 10.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-synonyms-sets.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-get-synonym
         #
         def get_synonyms_sets(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'synonyms.get_synonyms_sets' }
@@ -36,7 +37,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_GET
           path   = '_synonyms'

data/lib/elasticsearch/api/actions/synonyms/put_synonym.rb

@@ -15,20 +15,24 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Synonyms
       module Actions
-        # Creates or updates a synonyms set
+        # Create or update a synonym set.
+        # Synonyms sets are limited to a maximum of 10,000 synonym rules per set.
+        # If you need to manage more synonym rules, you can create multiple synonym sets.
+        # When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.
+        # This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.
         #
-        # @option arguments [String] :id The id of the synonyms set to be created or updated
+        # @option arguments [String] :id The ID of the synonyms set to be created or updated. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body Synonyms set rules (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-synonyms-set.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-put-synonym
         #
         def put_synonym(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'synonyms.put_synonym' }
@@ -49,7 +53,7 @@ module Elasticsearch
           _id = arguments.delete(:id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_synonyms/#{Utils.__listify(_id)}"
+          path   = "_synonyms/#{Utils.listify(_id)}"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb

@@ -15,26 +15,29 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Synonyms
       module Actions
-        # Creates or updates a synonym rule in a synonym set
+        # Create or update a synonym rule.
+        # Create or update a synonym rule in a synonym set.
+        # If any of the synonym rules included is invalid, the API returns an error.
+        # When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.
         #
-        # @option arguments [String] :set_id The id of the synonym set to be updated with the synonym rule
-        # @option arguments [String] :rule_id The id of the synonym rule to be updated or created
+        # @option arguments [String] :set_id The ID of the synonym set. (*Required*)
+        # @option arguments [String] :rule_id The ID of the synonym rule to be updated or created. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body Synonym rule (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-synonym-rule.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-put-synonym-rule
         #
         def put_synonym_rule(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'synonyms.put_synonym_rule' }
 
-          defined_params = %i[set_id rule_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:set_id, :rule_id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -53,7 +56,7 @@ module Elasticsearch
           _rule_id = arguments.delete(:rule_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_synonyms/#{Utils.__listify(_set_id)}/#{Utils.__listify(_rule_id)}"
+          path   = "_synonyms/#{Utils.listify(_set_id)}/#{Utils.listify(_rule_id)}"
           params = {}
 
           Elasticsearch::API::Response.new(

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

@@ -15,27 +15,35 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Tasks
       module Actions
-        # Cancels a task, if it can be cancelled through an API.
+        # Cancel a task.
+        # WARNING: The task management API is new and should still be considered a beta feature.
+        # The API may change in ways that are not backwards compatible.
+        # A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away.
+        # It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation.
+        # The get task information API will continue to list these cancelled tasks until they complete.
+        # The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.
+        # To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the +?detailed+ parameter to identify the other tasks the system is running.
+        # You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.
         # This functionality is Experimental and may be changed or removed
         # completely in a future release. Elastic will take a best effort approach
         # to fix any issues, but experimental features are not subject to the
         # support SLA of official GA features.
         #
-        # @option arguments [String] :task_id Cancel the task with specified task id (node_id:task_number)
-        # @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 cancelled. Leave empty to cancel all.
-        # @option arguments [String] :parent_task_id Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.
-        # @option arguments [Boolean] :wait_for_completion Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false
+        # @option arguments [String, Integer] :task_id The task identifier.
+        # @option arguments [String] :actions A comma-separated list or wildcard expression of actions that is used to limit the request.
+        # @option arguments [Array<String>] :nodes A comma-separated list of node IDs or names that is used to limit the request.
+        # @option arguments [String] :parent_task_id A parent task ID that is used to limit the tasks.
+        # @option arguments [Boolean] :wait_for_completion If true, the request blocks until all found tasks are complete.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-tasks
         #
         def cancel(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'tasks.cancel' }
@@ -54,7 +62,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = if _task_id
-                     "_tasks/#{Utils.__listify(_task_id)}/_cancel"
+                     "_tasks/#{Utils.listify(_task_id)}/_cancel"
                    else
                      '_tasks/_cancel'
                    end

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

@@ -15,25 +15,30 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Tasks
       module Actions
-        # Returns information about a task.
+        # Get task information.
+        # Get information about a task currently running in the cluster.
+        # WARNING: The task management API is new and should still be considered a beta feature.
+        # The API may change in ways that are not backwards compatible.
+        # If the task identifier is not found, a 404 response code indicates that there are no resources that match the request.
         # This functionality is Experimental and may be changed or removed
         # completely in a future release. Elastic will take a best effort approach
         # to fix any issues, but experimental features are not subject to the
         # support SLA of official GA features.
         #
-        # @option arguments [String] :task_id Return the task with specified id (node_id:task_number)
-        # @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [String] :task_id The task identifier. (*Required*)
+        # @option arguments [Time] :timeout The period to wait for a response.
+        #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Boolean] :wait_for_completion If +true+, the request blocks until the task has completed.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-tasks
         #
         def get(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'tasks.get' }
@@ -43,6 +48,8 @@ module Elasticsearch
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
+          raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
+
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
@@ -51,7 +58,7 @@ module Elasticsearch
           _task_id = arguments.delete(:task_id)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "_tasks/#{Utils.__listify(_task_id)}"
+          path   = "_tasks/#{Utils.listify(_task_id)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,29 +15,87 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Tasks
       module Actions
-        # Returns a list of tasks.
+        # Get all tasks.
+        # Get information about the tasks currently running on one or more nodes in the cluster.
+        # WARNING: The task management API is new and should still be considered a beta feature.
+        # The API may change in ways that are not backwards compatible.
+        # **Identifying running tasks**
+        # The +X-Opaque-Id header+, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information.
+        # This enables you to track certain calls or associate certain tasks with the client that started them.
+        # For example:
+        # +
+        # curl -i -H "X-Opaque-Id: 123456" "http://localhost:9200/_tasks?group_by=parents"
+        # +
+        # The API returns the following result:
+        # +
+        # HTTP/1.1 200 OK
+        # X-Opaque-Id: 123456
+        # content-type: application/json; charset=UTF-8
+        # content-length: 831
+        # {
+        #   "tasks" : {
+        #     "u5lcZHqcQhu-rUoFaqDphA:45" : {
+        #       "node" : "u5lcZHqcQhu-rUoFaqDphA",
+        #       "id" : 45,
+        #       "type" : "transport",
+        #       "action" : "cluster:monitor/tasks/lists",
+        #       "start_time_in_millis" : 1513823752749,
+        #       "running_time_in_nanos" : 293139,
+        #       "cancellable" : false,
+        #       "headers" : {
+        #         "X-Opaque-Id" : "123456"
+        #       },
+        #       "children" : [
+        #         {
+        #           "node" : "u5lcZHqcQhu-rUoFaqDphA",
+        #           "id" : 46,
+        #           "type" : "direct",
+        #           "action" : "cluster:monitor/tasks/lists[n]",
+        #           "start_time_in_millis" : 1513823752750,
+        #           "running_time_in_nanos" : 92133,
+        #           "cancellable" : false,
+        #           "parent_task_id" : "u5lcZHqcQhu-rUoFaqDphA:45",
+        #           "headers" : {
+        #             "X-Opaque-Id" : "123456"
+        #           }
+        #         }
+        #       ]
+        #     }
+        #   }
+        #  }
+        # +
+        # In this example, +X-Opaque-Id: 123456+ is the ID as a part of the response header.
+        # The +X-Opaque-Id+ in the task +headers+ is the ID for the task that was initiated by the REST request.
+        # The +X-Opaque-Id+ in the children +headers+ is the child task of the task that was initiated by the REST request.
         # This functionality is Experimental and may be changed or removed
         # completely in a future release. Elastic will take a best effort approach
         # to fix any issues, but experimental features are not subject to the
         # support SLA of official GA features.
         #
-        # @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.
-        # @option arguments [Boolean] :detailed Return detailed task information (default: false)
-        # @option arguments [String] :parent_task_id Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.
-        # @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 [String] :actions A comma-separated list or wildcard expression of actions used to limit the request.
+        #  For example, you can use +cluser:*+ to retrieve all cluster-related tasks.
+        # @option arguments [Boolean] :detailed If +true+, the response includes detailed information about the running tasks.
+        #  This information is useful to distinguish tasks from each other but is more costly to run.
+        # @option arguments [String] :group_by A key that is used to group tasks in the response.
+        #  The task lists can be grouped either by nodes or by parent tasks.
+        # @option arguments [String, Array] :nodes A comma-separated list of node IDs or names that is used to limit the returned information.
+        # @option arguments [String] :parent_task_id A parent task identifier that is used to limit returned information.
+        #  To return all tasks, omit this parameter or use a value of +-1+.
+        #  If the parent task is not found, the API does not return a 404 response code.
+        # @option arguments [Time] :timeout The period to wait for each node to respond.
+        #  If a node does not respond before its timeout expires, the response does not include its information.
+        #  However, timed out nodes are included in the +node_failures+ property. Server default: 30s.
+        # @option arguments [Boolean] :wait_for_completion If +true+, the request blocks until the operation is complete.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-tasks
         #
         def list(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'tasks.list' }
@@ -45,7 +103,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_GET
           path   = '_tasks'

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

@@ -15,19 +15,23 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Actions
-      # The terms enum API  can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.
+      # Get terms in an index.
+      # Discover terms that match a partial string in an index.
+      # This API is designed for low-latency look-ups used in auto-complete scenarios.
       #
-      # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
+      # @option arguments [String] :index A comma-separated list of data streams, indices, and index aliases to search.
+      #  Wildcard (+*+) expressions are supported.
+      #  To search all data streams or indices, omit this parameter or use +*+  or +_all+. (*Required*)
       # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body field name, string which is the prefix expected in matching terms, timeout and size for max number of results
+      # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-terms-enum.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-terms-enum
       #
       def terms_enum(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'terms_enum' }
@@ -52,7 +56,7 @@ module Elasticsearch
                    Elasticsearch::API::HTTP_GET
                  end
 
-        path = "#{Utils.__listify(_index)}/_terms_enum"
+        path   = "#{Utils.listify(_index)}/_terms_enum"
         params = {}
 
         Elasticsearch::API::Response.new(

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

@@ -15,36 +15,63 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Actions
-      # Returns information and statistics about terms in the fields of a particular document.
+      # Get term vector information.
+      # Get information and statistics about terms in the fields of a particular document.
+      # You can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.
+      # You can specify the fields you are interested in through the +fields+ parameter or by adding the fields to the request body.
+      # For example:
+      # +
+      # GET /my-index-000001/_termvectors/1?fields=message
+      # +
+      # Fields can be specified using wildcards, similar to the multi match query.
+      # Term vectors are real-time by default, not near real-time.
+      # This can be changed by setting +realtime+ parameter to +false+.
+      # You can request three types of values: _term information_, _term statistics_, and _field statistics_.
+      # By default, all term information and field statistics are returned for all fields but term statistics are excluded.
+      # **Term information**
+      # * term frequency in the field (always returned)
+      # * term positions (+positions: true+)
+      # * start and end offsets (+offsets: true+)
+      # * term payloads (+payloads: true+), as base64 encoded bytes
+      # If the requested information wasn't stored in the index, it will be computed on the fly if possible.
+      # Additionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.
       #
-      # @option arguments [String] :index The index in which the document resides.
-      # @option arguments [String] :id The id of the document, when not specified a doc param should be supplied.
-      # @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.
-      # @option arguments [Boolean] :offsets Specifies if term offsets should be returned.
-      # @option arguments [Boolean] :positions Specifies if term positions should be returned.
-      # @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 [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)
+      # @option arguments [String] :index The name of the index that contains the document. (*Required*)
+      # @option arguments [String] :id A unique identifier for the document.
+      # @option arguments [String, Array<String>] :fields A comma-separated list or wildcard expressions of fields to include in the statistics.
+      #  It is used as the default list unless a specific field list is provided in the +completion_fields+ or +fielddata_fields+ parameters.
+      # @option arguments [Boolean] :field_statistics If +true+, the response includes:
+      #  - The document count (how many documents contain this field).
+      #  - The sum of document frequencies (the sum of document frequencies for all terms in this field).
+      #  - The sum of total term frequencies (the sum of total term frequencies of each term in this field). Server default: true.
+      # @option arguments [Boolean] :offsets If +true+, the response includes term offsets. Server default: true.
+      # @option arguments [Boolean] :payloads If +true+, the response includes term payloads. Server default: true.
+      # @option arguments [Boolean] :positions If +true+, the response includes term positions. Server default: true.
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  It is random by default.
+      # @option arguments [Boolean] :realtime If true, the request is real-time as opposed to near-real-time. Server default: true.
+      # @option arguments [String] :routing A custom value that is used to route operations to a specific shard.
+      # @option arguments [Boolean] :term_statistics If +true+, the response includes:
+      #  - The total term frequency (how often a term occurs in all documents).
+      #  - The document frequency (the number of documents containing the current term).
+      #  By default these values are not returned since term statistics can have a serious performance impact.
+      # @option arguments [Integer] :version If +true+, returns the document version as part of a hit.
+      # @option arguments [String] :version_type The version type.
       # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body Define parameters and or supply a document to get termvectors for. See documentation.
+      # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-termvectors.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-termvectors
       #
       def termvectors(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'termvectors' }
 
-        defined_params = %i[index id].each_with_object({}) do |variable, set_variables|
+        defined_params = [:index, :id].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -68,9 +95,9 @@ module Elasticsearch
 
         arguments.delete(:endpoint)
         path = if _index && _id
-                 "#{Utils.__listify(_index)}/_termvectors/#{Utils.__listify(_id)}"
+                 "#{Utils.listify(_index)}/_termvectors/#{Utils.listify(_id)}"
                else
-                 "#{Utils.__listify(_index)}/_termvectors"
+                 "#{Utils.listify(_index)}/_termvectors"
                end
         params = Utils.process_params(arguments)