elasticsearch-api 8.18.0 → 9.0.1

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

@@ -15,25 +15,34 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Cat
       module Actions
-        # Returns information about snapshot repositories registered in the cluster.
+        # Get snapshot repository information.
+        # Get a list of snapshot repositories for a cluster.
+        # IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.
         #
-        # @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
-        # @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 [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, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
+        # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
+        #  Sorting defaults to ascending and can be changed by setting +:asc+
+        #  or +:desc+ as a suffix to the column name.
+        # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
+        #  local cluster state. If +false+ the list of selected nodes are computed
+        #  from the cluster state of the master node. In both cases the coordinating
+        #  node will send requests for further information to each selected node.
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
+        # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
+        #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
+        # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
+        #  can't be combined with any other query string option.
+        # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-repositories.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-repositories
         #
         def repositories(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.repositories' }
@@ -41,7 +50,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_GET
           path   = '_cat/repositories'

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

@@ -15,27 +15,39 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Cat
       module Actions
-        # Provides low-level information about the segments in the shards of an index.
+        # Get segment information.
+        # Get low-level information about the Lucene segments in index shards.
+        # For data streams, the API returns information about the backing indices.
+        # IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.
         #
-        # @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 [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, Array] :index A comma-separated list of data streams, indices, and aliases used to limit the request.
+        #  Supports wildcards (+*+).
+        #  To target all data streams and indices, omit this parameter or use +*+ or +_all+.
+        # @option arguments [String] :bytes The unit used to display byte values.
+        # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
+        # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
+        #  Sorting defaults to ascending and can be changed by setting +:asc+
+        #  or +:desc+ as a suffix to the column name.
+        # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
+        #  local cluster state. If +false+ the list of selected nodes are computed
+        #  from the cluster state of the master node. In both cases the coordinating
+        #  node will send requests for further information to each selected node.
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
+        # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
+        #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
+        # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
+        #  can't be combined with any other query string option.
+        # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-segments.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-segments
         #
         def segments(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.segments' }
@@ -48,13 +60,13 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _index
-                     "_cat/segments/#{Utils.__listify(_index)}"
+                     "_cat/segments/#{Utils.listify(_index)}"
                    else
                      '_cat/segments'
                    end

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

@@ -15,27 +15,36 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Cat
       module Actions
-        # Provides a detailed view of shard allocation on nodes.
+        # Get shard information.
+        # Get information about the shards in a cluster.
+        # For data streams, the API returns information about the backing indices.
+        # IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
         #
-        # @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 [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 [Boolean] :help Return help information
-        # @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, Array] :index A comma-separated list of data streams, indices, and aliases used to limit the request.
+        #  Supports wildcards (+*+).
+        #  To target all data streams and indices, omit this parameter or use +*+ or +_all+.
+        # @option arguments [String] :bytes The unit used to display byte values.
+        # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
+        # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
+        #  Sorting defaults to ascending and can be changed by setting +:asc+
+        #  or +:desc+ as a suffix to the column name.
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
+        # @option arguments [String] :time Unit used to display time values.
+        # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
+        #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
+        # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
+        #  can't be combined with any other query string option.
+        # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-shards.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-shards
         #
         def shards(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.shards' }
@@ -48,18 +57,18 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _index
-                     "_cat/shards/#{Utils.__listify(_index)}"
+                     "_cat/shards/#{Utils.listify(_index)}"
                    else
                      '_cat/shards'
                    end
           params = Utils.process_params(arguments)
-          params[:h] = Utils.__listify(params[:h]) if params[:h]
+          params[:h] = Utils.listify(params[:h]) if params[:h]
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -15,27 +15,37 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Cat
       module Actions
-        # Returns all snapshots in a specific repository.
+        # Get snapshot information.
+        # Get information about the snapshots stored in one or more repositories.
+        # A snapshot is a backup of an index or running Elasticsearch cluster.
+        # IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.
         #
-        # @option arguments [List] :repository Name of repository from which to fetch the snapshot information
-        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
-        # @option arguments [Boolean] :ignore_unavailable Set to true to ignore unavailable snapshots
-        # @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 [Boolean] :help Return help information
-        # @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, Array<String>] :repository A comma-separated list of snapshot repositories used to limit the request.
+        #  Accepts wildcard expressions.
+        #  +_all+ returns all repositories.
+        #  If any repository fails during the request, Elasticsearch returns an error.
+        # @option arguments [Boolean] :ignore_unavailable If +true+, the response does not include information from unavailable snapshots.
+        # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
+        # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
+        #  Sorting defaults to ascending and can be changed by setting +:asc+
+        #  or +:desc+ as a suffix to the column name.
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
+        # @option arguments [String] :time Unit used to display time values.
+        # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
+        #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
+        # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
+        #  can't be combined with any other query string option.
+        # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-snapshots.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-snapshots
         #
         def snapshots(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.snapshots' }
@@ -54,7 +64,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _repository
-                     "_cat/snapshots/#{Utils.__listify(_repository)}"
+                     "_cat/snapshots/#{Utils.listify(_repository)}"
                    else
                      '_cat/snapshots'
                    end

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

@@ -15,34 +15,41 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Cat
       module Actions
-        # Returns information about the tasks currently executing on one or more nodes in the cluster.
+        # Get task information.
+        # Get information about tasks currently running in the cluster.
+        # IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.
         # This functionality is Experimental and may be changed or removed
         # completely in a future release. Elastic will take a best effort approach
         # to fix any issues, but experimental features are not subject to the
         # support SLA of official GA features.
         #
-        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
-        # @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
-        # @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all.
-        # @option arguments [Boolean] :detailed Return detailed task information (default: false)
-        # @option arguments [String] :parent_task_id Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.
-        # @option arguments [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 [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 [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
-        # @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the task has completed.
+        # @option arguments [Array<String>] :actions The task action names, which are used to limit the response.
+        # @option arguments [Boolean] :detailed If +true+, the response includes detailed information about shard recoveries.
+        # @option arguments [Array<String>] :nodes Unique node identifiers, which are used to limit the response.
+        # @option arguments [String] :parent_task_id The parent task identifier, which is used to limit the response.
+        # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
+        # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
+        #  Sorting defaults to ascending and can be changed by setting +:asc+
+        #  or +:desc+ as a suffix to the column name.
+        # @option arguments [String] :time Unit used to display time values.
+        # @option arguments [Time] :timeout Period to wait for a response.
+        #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Boolean] :wait_for_completion If +true+, the request blocks until the task has completed.
+        # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
+        #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
+        # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
+        #  can't be combined with any other query string option.
+        # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-tasks
         #
         def tasks(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.tasks' }
@@ -50,7 +57,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_GET
           path   = '_cat/tasks'

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

@@ -15,26 +15,37 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Cat
       module Actions
-        # Returns information about existing templates.
+        # Get index template information.
+        # Get information about the index templates in a cluster.
+        # You can use index templates to apply index settings and field mappings to new indices at creation.
+        # IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.
         #
-        # @option arguments [String] :name A pattern that returned template names must match
-        # @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 [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] :name The name of the template to return.
+        #  Accepts wildcard expressions. If omitted, all templates are returned.
+        # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
+        # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
+        #  Sorting defaults to ascending and can be changed by setting +:asc+
+        #  or +:desc+ as a suffix to the column name.
+        # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
+        #  local cluster state. If +false+ the list of selected nodes are computed
+        #  from the cluster state of the master node. In both cases the coordinating
+        #  node will send requests for further information to each selected node.
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
+        # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
+        #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
+        # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
+        #  can't be combined with any other query string option.
+        # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-templates.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-templates
         #
         def templates(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.templates' }
@@ -53,7 +64,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _name
-                     "_cat/templates/#{Utils.__listify(_name)}"
+                     "_cat/templates/#{Utils.listify(_name)}"
                    else
                      '_cat/templates'
                    end

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

@@ -15,28 +15,38 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Cat
       module Actions
-        # Returns cluster-wide thread pool statistics per node.
-        # By default the active, queue and rejected statistics are returned for all thread pools.
+        # Get thread pool statistics.
+        # Get thread pool statistics for each node in a cluster.
+        # Returned information includes all built-in thread pools and custom thread pools.
+        # IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
         #
-        # @option arguments [List] :thread_pool_patterns A comma-separated list of regular-expressions to filter the thread pools in the output
-        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
-        # @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
-        # @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, Array<String>] :thread_pool_patterns A comma-separated list of thread pool names used to limit the request.
+        #  Accepts wildcard expressions.
+        # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
+        # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
+        #  Sorting defaults to ascending and can be changed by setting +:asc+
+        #  or +:desc+ as a suffix to the column name.
+        # @option arguments [String] :time The unit used to display time values.
+        # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
+        #  local cluster state. If +false+ the list of selected nodes are computed
+        #  from the cluster state of the master node. In both cases the coordinating
+        #  node will send requests for further information to each selected node.
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
+        # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
+        #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
+        # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
+        #  can't be combined with any other query string option.
+        # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-thread-pool.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-thread-pool
         #
         def thread_pool(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.thread_pool' }
@@ -55,12 +65,12 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _thread_pool_patterns
-                     "_cat/thread_pool/#{Utils.__listify(_thread_pool_patterns)}"
+                     "_cat/thread_pool/#{Utils.listify(_thread_pool_patterns)}"
                    else
                      '_cat/thread_pool'
                    end
           params = Utils.process_params(arguments)
-          params[:h] = Utils.__listify(params[:h]) if params[:h]
+          params[:h] = Utils.listify(params[:h]) if params[:h]
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -15,28 +15,37 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Cat
       module Actions
-        # Gets configuration and usage information about transforms.
+        # Get transform information.
+        # Get configuration and usage information about transforms.
+        # CAT APIs are only intended for human consumption using the Kibana
+        # console or command line. They are not intended for use by applications. For
+        # application consumption, use the get transform statistics API.
         #
-        # @option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms
-        # @option arguments [Integer] :from skips a number of transform configs, defaults to 0
-        # @option arguments [Integer] :size specifies a max number of transforms to get, defaults to 100
-        # @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 [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
-        # @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] :transform_id A transform identifier or a wildcard expression.
+        #  If you do not specify one of these options, the API returns information for all transforms.
+        # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the +_all+ string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.
+        #  If +true+, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches.
+        #  If +false+, the request returns a 404 status code when there are no matches or only partial matches. Server default: true.
+        # @option arguments [Integer] :from Skips the specified number of transforms. Server default: 0.
+        # @option arguments [String, Array<String>] :h Comma-separated list of column names to display. Server default: changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state.
+        # @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the response.
+        # @option arguments [String] :time The unit used to display time values.
+        # @option arguments [Integer] :size The maximum number of transforms to obtain. Server default: 100.
+        # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
+        #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
+        # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
+        #  can't be combined with any other query string option.
+        # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-transforms.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-transforms
         #
         def transforms(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'cat.transforms' }
@@ -55,7 +64,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _transform_id
-                     "_cat/transforms/#{Utils.__listify(_transform_id)}"
+                     "_cat/transforms/#{Utils.listify(_transform_id)}"
                    else
                      '_cat/transforms'
                    end

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

@@ -15,33 +15,31 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Actions
-      # Explicitly clears the search context for a scroll.
+      # Clear a scrolling search.
+      # Clear the search context and results for a scrolling search.
       #
-      # @option arguments [List] :scroll_id A comma-separated list of scroll IDs to clear *Deprecated*
+      # @option arguments [String, Array] :scroll_id A comma-separated list of scroll IDs to clear.
+      #  To clear all scroll IDs, use +_all+.
+      #  IMPORTANT: Scroll IDs can be long. It is recommended to specify scroll IDs in the request body parameter.
       # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter
+      # @option arguments [Hash] :body request body
       #
       # *Deprecation notice*:
       # A scroll id can be quite large and should be specified as part of the body
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/clear-scroll-api.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-clear-scroll
       #
       def clear_scroll(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'clear_scroll' }
 
-        defined_params = [:scroll_id].each_with_object({}) do |variable, set_variables|
-          set_variables[variable] = arguments[variable] if arguments.key?(variable)
-        end
-        request_opts[:defined_params] = defined_params unless defined_params.empty?
-
         arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
@@ -50,15 +48,11 @@ module Elasticsearch
         _scroll_id = arguments.delete(:scroll_id)
 
         method = Elasticsearch::API::HTTP_DELETE
-        path   = if _scroll_id
-                   "_search/scroll/#{Utils.__listify(_scroll_id)}"
-                 else
-                   '_search/scroll'
-                 end
+        path   = '_search/scroll'
         params = Utils.process_params(arguments)
 
         if Array(arguments[:ignore]).include?(404)
-          Utils.__rescue_from_not_found do
+          Utils.rescue_from_not_found do
             Elasticsearch::API::Response.new(
               perform_request(method, path, params, body, headers, request_opts)
             )