Auto-generated code for 8.19

elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module AsyncSearch
       module Actions
-        # Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.
+        # Delete an async search
         #
         # @option arguments [String] :id The async search ID
         # @option arguments [Hash] :headers Custom HTTP headers

elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module AsyncSearch
       module Actions
-        # Retrieves the results of a previously submitted async search request given its ID.
+        # Get async search results
         #
         # @option arguments [String] :id The async search ID
         # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response

elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module AsyncSearch
       module Actions
-        # Retrieves the status of a previously submitted async search request given its ID.
+        # Get the async search status
         #
         # @option arguments [String] :id The async search ID
         # @option arguments [Time] :keep_alive Specify the time interval in which the results (partial or final) for this search will be available

elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module AsyncSearch
       module Actions
-        # Executes a search request asynchronously.
+        # Run an async search
         #
         # @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 [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response

elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/delete_autoscaling_policy.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Autoscaling
       module Actions
-        # Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
+        # Delete an autoscaling policy
         #
         # @option arguments [String] :name the name of the autoscaling policy
         # @option arguments [Time] :master_timeout Timeout for processing on master node

elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_capacity.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Autoscaling
       module Actions
-        # Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
+        # Get the autoscaling capacity
         #
         # @option arguments [Time] :master_timeout Timeout for processing on master node
         # @option arguments [Hash] :headers Custom HTTP headers

elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_policy.rb

@@ -22,13 +22,13 @@ module Elasticsearch
   module API
     module Autoscaling
       module Actions
-        # Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
+        # Get an autoscaling policy
         #
         # @option arguments [String] :name the name of the autoscaling policy
         # @option arguments [Time] :master_timeout Timeout for processing on master node
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-get-autoscaling-policy.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-get-autoscaling-capacity.html
         #
         def get_autoscaling_policy(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'autoscaling.get_autoscaling_policy' }

elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/put_autoscaling_policy.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Autoscaling
       module Actions
-        # Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
+        # Create or update an autoscaling policy
         #
         # @option arguments [String] :name the name of the autoscaling policy
         # @option arguments [Time] :master_timeout Timeout for processing on master node

elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb

@@ -21,7 +21,7 @@
 module Elasticsearch
   module API
     module Actions
-      # Allows to perform multiple index/update/delete operations in a single request.
+      # Bulk index or delete documents
       #
       # @option arguments [String] :index Default index for items which don't provide one
       # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the bulk 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)

elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Shows information about currently configured aliases to indices including filter and routing infos.
+        # Get aliases
         #
         # @option arguments [List] :name A comma-separated list of alias names to return
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml

elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb

@@ -22,11 +22,11 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
+        # Get shard allocation information
         #
         # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [List] :h Comma-separated list of column names to display

elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Returns information about existing component_templates templates.
+        # Get component templates
         #
         # @option arguments [String] :name A pattern that returned component template names must match
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml

elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Provides quick access to the document count of the entire cluster, or individual indices.
+        # Get a document count
         #
         # @option arguments [List] :index A comma-separated list of index names to limit the returned information
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml

elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb

@@ -22,11 +22,11 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
+        # Get field data cache information
         #
         # @option arguments [List] :fields A comma-separated list of fields to return the fielddata size
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by

elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Returns a concise representation of the cluster health.
+        # Get the cluster health status
         #
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [List] :h Comma-separated list of column names to display

elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Returns help for the Cat APIs.
+        # Get CAT help
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #

elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb

@@ -22,11 +22,11 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Returns information about indices: number of primaries and replicas, document counts, disk size, ...
+        # Get index information
         #
         # @option arguments [List] :index A comma-separated list of index names to limit the returned information
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (options: green, yellow, red)

elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Returns information about the master node.
+        # Get master node information
         #
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)

elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb

@@ -22,11 +22,11 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Gets configuration and usage information about data frame analytics jobs.
+        # Get data frame analytics jobs
         #
         # @option arguments [String] :id The ID of the data frame analytics to fetch
         # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
@@ -35,7 +35,7 @@ module Actions
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-dfanalytics.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-dfanalytics.html
         #
         def ml_data_frame_analytics(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_data_frame_analytics' }

elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Gets configuration and usage information about datafeeds.
+        # Get datafeeds
         #
         # @option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch
         # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
@@ -34,7 +34,7 @@ module Actions
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-datafeeds.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-datafeeds.html
         #
         def ml_datafeeds(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_datafeeds' }

elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb

@@ -22,11 +22,11 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Gets configuration and usage information about anomaly detection jobs.
+        # Get anomaly detection jobs
         #
         # @option arguments [String] :job_id The ID of the jobs stats to fetch
         # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
@@ -35,7 +35,7 @@ module Actions
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-anomaly-detectors.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-anomaly-detectors.html
         #
         def ml_jobs(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_jobs' }

elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb

@@ -22,13 +22,13 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Gets configuration and usage information about inference trained models.
+        # Get trained models
         #
         # @option arguments [String] :model_id The ID of the trained models stats to fetch
         # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)
         # @option arguments [Integer] :from skips a number of trained models
         # @option arguments [Integer] :size specifies a max number of trained models to get
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information

elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Returns information about custom node attributes.
+        # Get node attribute information
         #
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)

elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb

@@ -22,9 +22,9 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Returns basic statistics about performance of cluster nodes.
+        # Get node information
         #
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [Boolean] :full_id Return the full node ID instead of the shortened version (default: false)
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node

elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Returns a concise representation of the cluster pending tasks.
+        # Get pending task information
         #
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)

elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Returns information about installed plugins across nodes node.
+        # Get plugin information
         #
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)

elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb

@@ -22,12 +22,12 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Returns information about index shard recoveries, both on-going completed.
+        # Get shard recovery information
         #
         # @option arguments [List] :index Comma-separated list or wildcard expression of index names to limit the returned information
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
         # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information

elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Returns information about snapshot repositories registered in the cluster.
+        # Get snapshot repository information
         #
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node

elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb

@@ -22,13 +22,13 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Provides low-level information about the segments in the shards of an index.
+        # Get segment information
         #
         # @option arguments [List] :index A comma-separated list of index names to limit the returned information
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by