elasticsearch-api 8.19.0 → 8.19.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2b7c54ab2ca8331783f1e17cdadbd7b6651511c3432feb84a3a04b51c52d399
-  data.tar.gz: 6e2d55426372cdada1adac576c04eebc8aca8b7e9ddb07614cae36a266dae1ba
+  metadata.gz: ed53f807e0771ab53759f63dd19e7ca6d227427235edb24fea5664ba346482b2
+  data.tar.gz: 45afa720aec358178fadf9f8bae1e146a2878a4d6a1ad3908972168bb80d9b33
 SHA512:
-  metadata.gz: bfb93aba0c938b39474c0af63051475fee87ffb45a37c5b3730a979150581537ff73489afd1d2e722b94cba112f868a6817ea735db5c8720087ec01f23936f47
-  data.tar.gz: 8914ac6ff3d5a69a0fb6943c70ac8eba7a3265ade150f7cc1175def24858cf244dacec3de45134b51d048a877c9fad4b95e6424df1885caf67cf4e8640d9e774
+  metadata.gz: 955d7383be1e85cc29fa3eadfb7af9f0b96d1c09ec05851c879dcc4037700553e9f45598c6cb99a8027f3b7d2ba4b9bb1cf235231c5a2306c76af4e20cfd0d9a
+  data.tar.gz: 842c3ef30e0c52969a42fd098ee4d176e45a5cd588556de6b48d64f9cc5e50cf82fb0b405b6795ed3edb0bb65fba74f444a9b266dc6a94253b366d29ef26711d

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

@@ -22,12 +22,12 @@ 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
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/async-search.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html
         #
         def delete(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'async_search.delete' }

data/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
@@ -30,7 +30,7 @@ module Elasticsearch
         # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/async-search.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html
         #
         def get(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'async_search.get' }

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

@@ -22,13 +22,13 @@ 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
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/async-search.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html
         #
         def status(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'async_search.status' }

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

@@ -22,13 +22,13 @@ 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
         # @option arguments [Boolean] :keep_on_completion Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)
         # @option arguments [Time] :keep_alive Update the time interval in which the results (partial or final) for this search will be available
-        # @option arguments [Number] :batched_reduce_size The number of shard results that should be reduced at once on the coordinating node. This value should be used as the granularity at which progress results will be made available.
+        # @option arguments [Long] :batched_reduce_size The number of shard results that should be reduced at once on the coordinating node. This value should be used as the granularity at which progress results will be made available.
         # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to true
         # @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)
@@ -38,7 +38,7 @@ module Elasticsearch
         # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
         # @option arguments [List] :stored_fields A comma-separated list of stored fields to return as part of a hit
         # @option arguments [List] :docvalue_fields A comma-separated list of fields to return as the docvalue representation of a field for each hit
-        # @option arguments [Number] :from Starting offset (default: 0)
+        # @option arguments [Integer] :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] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
         # @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)
@@ -49,16 +49,16 @@ module Elasticsearch
         # @option arguments [String] :q Query in the Lucene query string syntax
         # @option arguments [List] :routing A comma-separated list of specific routing values
         # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
-        # @option arguments [Number] :size Number of hits to return (default: 10)
+        # @option arguments [Integer] :size Number of hits to return (default: 10)
         # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
         # @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 [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 [String] :suggest_field Specify which field to use for suggestions
         # @option arguments [String] :suggest_mode Specify suggest mode (options: missing, popular, always)
-        # @option arguments [Number] :suggest_size How many suggestions to return in response
+        # @option arguments [Long] :suggest_size How many suggestions to return in response
         # @option arguments [String] :suggest_text The source text for which the suggestions should be returned
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Boolean] :track_scores Whether to calculate and return scores even if they are not used for sorting
@@ -67,11 +67,11 @@ module Elasticsearch
         # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
         # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
         # @option arguments [Boolean] :seq_no_primary_term Specify whether to return sequence number and primary term of the last modification of each hit
-        # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
+        # @option arguments [Integer] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The search definition using the Query DSL
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/async-search.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html
         #
         def submit(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'async_search.submit' }

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

@@ -22,14 +22,14 @@ 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
         # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-delete-autoscaling-policy.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-delete-autoscaling-policy.html
         #
         def delete_autoscaling_policy(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'autoscaling.delete_autoscaling_policy' }

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

@@ -22,12 +22,12 @@ 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
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-get-autoscaling-capacity.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-get-autoscaling-capacity.html
         #
         def get_autoscaling_capacity(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'autoscaling.get_autoscaling_capacity' }

data/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.18/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' }

data/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
@@ -30,7 +30,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body the specification of the autoscaling policy (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-put-autoscaling-policy.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-put-autoscaling-policy.html
         #
         def put_autoscaling_policy(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'autoscaling.put_autoscaling_policy' }

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

@@ -21,27 +21,26 @@
 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)
       # @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 [String] :routing Specific routing value
       # @option arguments [Time] :timeout Explicit operation timeout
-      # @option arguments [String] :type Default document type for items which don't provide one
       # @option arguments [List] :_source True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
       # @option arguments [List] :_source_excludes Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
       # @option arguments [List] :_source_includes Default list of fields to extract and return from the _source field, can be overridden on each sub-request
       # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
-      # @option arguments [Boolean] :require_alias Sets require_alias for all incoming documents. Defaults to unset (false)
-      # @option arguments [Boolean] :require_data_stream When true, requires the destination to be a data stream (existing or to-be-created). Default is false
+      # @option arguments [Boolean] :require_alias If true, the request's actions must target an index alias. Defaults to false.
+      # @option arguments [Boolean] :require_data_stream If true, the request's actions must target a data stream (existing or to-be-created). Default to false
       # @option arguments [Boolean] :list_executed_pipelines Sets list_executed_pipelines for all incoming documents. Defaults to unset (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
       # @option arguments [String|Array] :body The operation definition and data (action-data pairs), separated by newlines. Array of Strings, Header/Data pairs,
       # or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.__bulkify documentation.
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/docs-bulk.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-bulk.html
       #
       def bulk(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'bulk' }

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

@@ -34,7 +34,7 @@ module Elasticsearch
       # @option arguments [Boolean] :local_only True if only the node being called should be considered
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://github.com/elastic/elasticsearch/blob/8.18/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/README.asciidoc#require-or-skip-api-capabilities
+      # @see https://github.com/elastic/elasticsearch/blob/8.19/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/README.asciidoc#require-or-skip-api-capabilities
       #
       def capabilities(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'capabilities' }

data/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
@@ -32,9 +32,11 @@ module Elasticsearch
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
+        # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-alias.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-alias.html
         #
         def aliases(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.aliases' }

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

@@ -22,11 +22,12 @@ 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 [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
         # @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
@@ -35,7 +36,7 @@ module Elasticsearch
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-allocation.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-allocation.html
         #
         def allocation(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.allocation' }

data/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
@@ -32,9 +32,11 @@ module Elasticsearch
         # @option arguments [Boolean] :help Return help information
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         # @option arguments [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
+        # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-component-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-component-templates.html
         #
         def component_templates(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.component_templates' }

data/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
@@ -30,9 +30,11 @@ module Elasticsearch
         # @option arguments [Boolean] :help Return help information
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         # @option arguments [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
+        # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-count.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-count.html
         #
         def count(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.count' }

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

@@ -22,18 +22,19 @@ 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
         # @option arguments [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-fielddata.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-fielddata.html
         #
         def fielddata(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.fielddata' }

data/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
@@ -31,9 +31,10 @@ module Elasticsearch
         # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
         # @option arguments [Boolean] :ts Set to false to disable timestamping
         # @option arguments [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-health.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-health.html
         #
         def health(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.health' }

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

@@ -22,11 +22,11 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-        # Returns help for the Cat APIs.
+        # Get CAT help
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat.html
         #
         def help(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.help' }

data/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)
@@ -39,7 +39,7 @@ module Elasticsearch
         # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-indices.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-indices.html
         #
         def indices(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.indices' }

data/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)
@@ -31,9 +31,11 @@ module Elasticsearch
         # @option arguments [Boolean] :help Return help information
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         # @option arguments [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
+        # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-master.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-master.html
         #
         def master(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.master' }

data/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 Elasticsearch
         # @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.18/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' }

data/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)
@@ -32,9 +32,10 @@ module Elasticsearch
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
         # @option arguments [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/8.18/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' }

data/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 Elasticsearch
         # @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.18/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' }

data/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
@@ -37,7 +37,7 @@ module Elasticsearch
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-trained-model.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-trained-model.html
         #
         def ml_trained_models(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_trained_models' }

data/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)
@@ -31,9 +31,11 @@ module Elasticsearch
         # @option arguments [Boolean] :help Return help information
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         # @option arguments [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
+        # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-nodeattrs.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-nodeattrs.html
         #
         def nodeattrs(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.nodeattrs' }

data/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
@@ -36,7 +36,7 @@ module Elasticsearch
         # @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-nodes.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-nodes.html
         #
         def nodes(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.nodes' }

data/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)
@@ -32,9 +32,10 @@ module Elasticsearch
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
         # @option arguments [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-pending-tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-pending-tasks.html
         #
         def pending_tasks(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.pending_tasks' }