elasticsearch-api 8.19.1 → 8.19.2

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module SnapshotLifecycleManagement
       module Actions
-        # Retrieves the status of snapshot lifecycle management (SLM).
+        # Get the snapshot lifecycle management status
         #
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb

@@ -22,13 +22,13 @@ module Elasticsearch
   module API
     module SnapshotLifecycleManagement
       module Actions
-        # Creates or updates a snapshot lifecycle policy.
+        # Create or update a policy
         #
         # @option arguments [String] :policy_id The id of the snapshot lifecycle policy
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The snapshot lifecycle policy definition to register
+        # @option arguments [Hash] :body The snapshot lifecycle policy definition to register (*Required*)
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/slm-api-put-policy.html
         #
@@ -40,6 +40,7 @@ module Elasticsearch
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'policy_id' missing" unless arguments[:policy_id]
 
           arguments = arguments.clone

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module SnapshotLifecycleManagement
       module Actions
-        # Turns on snapshot lifecycle management (SLM).
+        # Start snapshot lifecycle management
         #
         # @option arguments [Time] :master_timeout Timeout for processing on master node
         # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module SnapshotLifecycleManagement
       module Actions
-        # Turns off snapshot lifecycle management (SLM).
+        # Stop snapshot lifecycle management
         #
         # @option arguments [Time] :master_timeout Timeout for processing on master node
         # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster

data/lib/elasticsearch/api/actions/sql/clear_cursor.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module SQL
       module Actions
-        # Clears the SQL cursor
+        # Clear an SQL search cursor
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body Specify the cursor value in the `cursor` element to clean the cursor. (*Required*)

data/lib/elasticsearch/api/actions/sql/delete_async.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module SQL
       module Actions
-        # Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.
+        # Delete an async SQL search
         #
         # @option arguments [String] :id The async search ID
         # @option arguments [Hash] :headers Custom HTTP headers

data/lib/elasticsearch/api/actions/sql/get_async.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module SQL
       module Actions
-        # Returns the current status and available results for an async SQL search or stored synchronous SQL search
+        # Get async SQL search results
         #
         # @option arguments [String] :id The async search ID
         # @option arguments [String] :delimiter Separator for CSV results

data/lib/elasticsearch/api/actions/sql/get_async_status.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module SQL
       module Actions
-        # Returns the current status of an async SQL search or a stored synchronous SQL search
+        # Get the async SQL search status
         #
         # @option arguments [String] :id The async search ID
         # @option arguments [Hash] :headers Custom HTTP headers

data/lib/elasticsearch/api/actions/sql/query.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module SQL
       module Actions
-        # Executes a SQL request
+        # Get SQL search results
         #
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [Hash] :headers Custom HTTP headers

data/lib/elasticsearch/api/actions/sql/translate.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module SQL
       module Actions
-        # Translates SQL into Elasticsearch queries
+        # Translate SQL into Elasticsearch queries
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body Specify the query in the `query` element. (*Required*)

data/lib/elasticsearch/api/actions/ssl/certificates.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module SSL
       module Actions
-        # Retrieves information about the X.509 certificates used to encrypt communications in the cluster.
+        # Get SSL certificates
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #

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

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Synonyms
       module Actions
-        # Deletes a synonym set
+        # Delete a synonym set
         #
         # @option arguments [String] :id The id of the synonyms set to be deleted
         # @option arguments [Hash] :headers Custom HTTP headers

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

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Synonyms
       module Actions
-        # Deletes a synonym rule in a synonym set
+        # Delete a synonym rule
         #
         # @option arguments [String] :set_id The id of the synonym set to be updated
         # @option arguments [String] :rule_id The id of the synonym rule to be deleted

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

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Synonyms
       module Actions
-        # Retrieves a synonym set
+        # Get a synonym set
         #
         # @option arguments [String] :id The name of the synonyms set to be retrieved
         # @option arguments [Integer] :from Starting offset

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

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Synonyms
       module Actions
-        # Retrieves a synonym rule from a synonym set
+        # Get a synonym rule
         #
         # @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

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

@@ -22,13 +22,13 @@ module Elasticsearch
   module API
     module Synonyms
       module Actions
-        # Retrieves a summary of all defined synonym sets
+        # Get all synonym sets
         #
         # @option arguments [Integer] :from Starting offset
         # @option arguments [Integer] :size specifies a max number of results to get
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/list-synonyms-sets.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-synonyms-set.html
         #
         def get_synonyms_sets(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'synonyms.get_synonyms_sets' }

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

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Synonyms
       module Actions
-        # Creates or updates a synonyms set
+        # Create or update a synonym set
         #
         # @option arguments [String] :id The id of the synonyms set to be created or updated
         # @option arguments [Hash] :headers Custom HTTP headers

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

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Synonyms
       module Actions
-        # Creates or updates a synonym rule in a synonym set
+        # Create or update a synonym 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

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

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Tasks
       module Actions
-        # Cancels a task, if it can be cancelled through an API.
+        # Cancel a 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

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

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Tasks
       module Actions
-        # Returns information about a task.
+        # Get task information
         # 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

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

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Tasks
       module Actions
-        # Returns a list of tasks.
+        # Get all tasks
         # 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

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

@@ -21,11 +21,11 @@
 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
       #
       # @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 [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 field name, string which is the prefix expected in matching terms, timeout and size for max number of results (*Required*)
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-terms-enum.html
       #
@@ -37,22 +37,18 @@ module Elasticsearch
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
         arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
-        body = arguments.delete(:body)
+        body   = arguments.delete(:body)
 
         _index = arguments.delete(:index)
 
-        method = if body
-                   Elasticsearch::API::HTTP_POST
-                 else
-                   Elasticsearch::API::HTTP_GET
-                 end
-
-        path = "#{Utils.__listify(_index)}/_terms_enum"
+        method = Elasticsearch::API::HTTP_POST
+        path   = "#{Utils.__listify(_index)}/_terms_enum"
         params = {}
 
         Elasticsearch::API::Response.new(

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

@@ -21,7 +21,7 @@
 module Elasticsearch
   module API
     module Actions
-      # Returns information and statistics about terms in the fields of a particular document.
+      # Get term vector information
       #
       # @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.
@@ -34,7 +34,7 @@ module Elasticsearch
       # @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 [Long] :version Explicit version number for concurrency control
       # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte)
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body Define parameters and or supply a document to get termvectors for. See documentation.

data/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module TextStructure
       module Actions
-        # Finds the structure of a text field in an index.
+        # Find the structure of a text field
         #
         # @option arguments [String] :index The index containing the analyzed field (*Required*)
         # @option arguments [String] :field The field that should be analyzed (*Required*)

data/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module TextStructure
       module Actions
-        # Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch.
+        # Find the structure of text messages
         #
         # @option arguments [Time] :timeout Timeout after which the analysis will be aborted
         # @option arguments [String] :format Optional parameter to specify the high level file format (options: ndjson, xml, delimited, semi_structured_text)

data/lib/elasticsearch/api/actions/text_structure/find_structure.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module TextStructure
       module Actions
-        # Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.
+        # Find the structure of a text file
         #
         # @option arguments [Integer] :lines_to_sample How many lines of the file should be included in the analysis
         # @option arguments [Integer] :line_merge_size_limit Maximum number of characters permitted in a single message when lines are merged to create messages.

data/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module TextStructure
       module Actions
-        # Tests a Grok pattern on some text.
+        # Test a Grok pattern
         #
         # @option arguments [String] :ecs_compatibility Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'
         # @option arguments [Hash] :headers Custom HTTP headers

data/lib/elasticsearch/api/actions/transform/delete_transform.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Transform
       module Actions
-        # Deletes an existing transform.
+        # Delete a transform
         #
         # @option arguments [String] :transform_id The id of the transform to delete
         # @option arguments [Boolean] :force When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted.

data/lib/elasticsearch/api/actions/transform/get_node_stats.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Transform
       module Actions
-        # Retrieves transform usage information for transform nodes.
+        # Retrieves transform usage information for transform nodes
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #

data/lib/elasticsearch/api/actions/transform/get_transform.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Transform
       module Actions
-        # Retrieves configuration information for transforms.
+        # Get transforms
         #
         # @option arguments [String] :transform_id The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms
         # @option arguments [Integer] :from skips a number of transform configs, defaults to 0

data/lib/elasticsearch/api/actions/transform/get_transform_stats.rb

@@ -22,11 +22,11 @@ module Elasticsearch
   module API
     module Transform
       module Actions
-        # Retrieves usage information for transforms.
+        # Get transform stats
         #
         # @option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms
-        # @option arguments [Number] :from skips a number of transform stats, defaults to 0
-        # @option arguments [Number] :size specifies a max number of transform stats to get, defaults to 100
+        # @option arguments [Long] :from skips a number of transform stats, defaults to 0
+        # @option arguments [Long] :size specifies a max number of transform stats to get, defaults to 100
         # @option arguments [Time] :timeout Controls the time to wait for the stats
         # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
         # @option arguments [Hash] :headers Custom HTTP headers

data/lib/elasticsearch/api/actions/transform/preview_transform.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Transform
       module Actions
-        # Previews a transform.
+        # Preview a transform
         #
         # @option arguments [String] :transform_id The id of the transform to preview.
         # @option arguments [Time] :timeout Controls the time to wait for the preview

data/lib/elasticsearch/api/actions/transform/put_transform.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Transform
       module Actions
-        # Instantiates a transform.
+        # Create a transform
         #
         # @option arguments [String] :transform_id The id of the new transform.
         # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false.

data/lib/elasticsearch/api/actions/transform/reset_transform.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Transform
       module Actions
-        # Resets an existing transform.
+        # Reset a transform
         #
         # @option arguments [String] :transform_id The id of the transform to reset
         # @option arguments [Boolean] :force When `true`, the transform is reset regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be reset.

data/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Transform
       module Actions
-        # Schedules now a transform.
+        # Schedule a transform to start now
         #
         # @option arguments [String] :transform_id The id of the transform. (*Required*)
         # @option arguments [Time] :timeout Controls the time to wait for the scheduling to take place

data/lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb

@@ -22,13 +22,13 @@ module Elasticsearch
   module API
     module Transform
       module Actions
-        # Sets a cluster wide upgrade_mode setting that prepares transform indices for an upgrade.
+        # Set upgrade_mode for transform indices
         #
         # @option arguments [Boolean] :enabled Whether to enable upgrade_mode Transform setting or not. Defaults to false.
         # @option arguments [Time] :timeout Controls the time to wait before action times out. Defaults to 30 seconds
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/transform-set-upgrade-mode.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-set-upgrade-mode
         #
         def set_upgrade_mode(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'transform.set_upgrade_mode' }

data/lib/elasticsearch/api/actions/transform/start_transform.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Transform
       module Actions
-        # Starts one or more transforms.
+        # Start a transform
         #
         # @option arguments [String] :transform_id The id of the transform to start
         # @option arguments [String] :from Restricts the set of transformed entities to those changed after this time

data/lib/elasticsearch/api/actions/transform/stop_transform.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Transform
       module Actions
-        # Stops one or more transforms.
+        # Stop transforms
         #
         # @option arguments [String] :transform_id The id of the transform to stop
         # @option arguments [Boolean] :force Whether to force stop a failed transform or not. Default to false

data/lib/elasticsearch/api/actions/transform/update_transform.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Transform
       module Actions
-        # Updates certain properties of a transform.
+        # Update a transform
         #
         # @option arguments [String] :transform_id The id of the transform. (*Required*)
         # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false.
@@ -30,7 +30,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The update transform definition (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-transform-update-transform
         #
         def update_transform(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'transform.update_transform' }

data/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb

@@ -22,13 +22,13 @@ module Elasticsearch
   module API
     module Transform
       module Actions
-        # Upgrades all transforms.
+        # Upgrade all transforms
         #
         # @option arguments [Boolean] :dry_run Whether to only check for updates but don't execute
         # @option arguments [Time] :timeout Controls the time to wait for the upgrade
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/upgrade-transforms.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-transform-upgrade-transforms
         #
         def upgrade_transforms(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'transform.upgrade_transforms' }

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

@@ -21,7 +21,7 @@
 module Elasticsearch
   module API
     module Actions
-      # Updates a document with a script or partial document.
+      # Update a document
       #
       # @option arguments [String] :id Document ID
       # @option arguments [String] :index The name of the index
@@ -31,11 +31,11 @@ module Elasticsearch
       # @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] :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 [Integer] :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] :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 [Long] :if_seq_no only perform the update operation if the last operation that has changed the document has the specified sequence number
+      # @option arguments [Long] :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 [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Defaults to true.
       # @option arguments [Hash] :headers Custom HTTP headers

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

@@ -21,15 +21,14 @@
 module Elasticsearch
   module API
     module Actions
-      # Performs an update on every document in the index without changing the source,
-      # for example to pick up a mapping change.
+      # Update documents
       #
       # @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] :analyzer The analyzer to use for the query string
       # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
       # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
       # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
-      # @option arguments [Number] :from Starting offset (default: 0)
+      # @option arguments [Long] :from Starting offset (default: 0)
       # @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] :conflicts What to do when the update by query hits version conflicts? (options: abort, proceed)
@@ -42,9 +41,9 @@ module Elasticsearch
       # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
       # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
       # @option arguments [Time] :search_timeout Explicit timeout for each search request. Defaults to no timeout.
-      # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)
+      # @option arguments [Long] :max_docs Maximum number of documents to process (default: all documents)
       # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
-      # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
+      # @option arguments [Long] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
       # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
       # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
       # @option arguments [Boolean] :version_type Should the document increment the version number (internal) on hit or not (reindex)
@@ -52,7 +51,7 @@ module Elasticsearch
       # @option arguments [Boolean] :refresh Should the affected indexes be refreshed?
       # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable.
       # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update by query 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 [Number] :scroll_size Size on the scroll request powering the update by query
+      # @option arguments [Long] :scroll_size Size on the scroll request powering the update by query
       # @option arguments [Boolean] :wait_for_completion Should the request should block until the update by query operation is complete.
       # @option arguments [Number] :requests_per_second The throttle to set on this request in sub-requests per second. -1 means no throttle.
       # @option arguments [Number|string] :slices The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.

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

@@ -21,13 +21,13 @@
 module Elasticsearch
   module API
     module Actions
-      # Changes the number of requests per second for a particular Update By Query operation.
+      # Throttle an update by query operation
       #
       # @option arguments [String] :task_id The task id to rethrottle
       # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*)
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-update-by-query.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-update-by-query.html#docs-update-by-query-rethrottle
       #
       def update_by_query_rethrottle(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'update_by_query_rethrottle' }

data/lib/elasticsearch/api/actions/watcher/ack_watch.rb

@@ -22,13 +22,13 @@ module Elasticsearch
   module API
     module Watcher
       module Actions
-        # Acknowledges a watch, manually throttling the execution of the watch's actions.
+        # Acknowledge a watch
         #
         # @option arguments [String] :watch_id Watch ID
         # @option arguments [List] :action_id A comma-separated list of the action ids to be acked
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-ack-watch.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-ack-watch
         #
         def ack_watch(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.ack_watch' }

data/lib/elasticsearch/api/actions/watcher/activate_watch.rb

@@ -22,12 +22,12 @@ module Elasticsearch
   module API
     module Watcher
       module Actions
-        # Activates a currently inactive watch.
+        # Activate a watch
         #
         # @option arguments [String] :watch_id Watch ID
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-activate-watch.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-activate-watch
         #
         def activate_watch(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.activate_watch' }