elasticsearch-api 8.17.2 → 9.0.0

data/lib/elasticsearch/api/actions/nodes/stats.rb

@@ -15,35 +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 Nodes
       module Actions
-        # Returns statistical information about nodes in the cluster.
+        # Get node statistics.
+        # Get statistics for nodes in a cluster.
+        # By default, all stats are returned. You can limit the returned information by using metrics.
         #
-        # @option arguments [List] :node_id 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] :metric Limit the information returned to the specified metrics (options: _all, breaker, fs, http, indices, jvm, os, process, thread_pool, transport, discovery, indexing_pressure)
-        # @option arguments [List] :index_metric Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, bulk, shard_stats)
-        # @option arguments [List] :completion_fields A comma-separated list of fields for the `completion` index metric (supports wildcards)
-        # @option arguments [List] :fielddata_fields A comma-separated list of fields for the `fielddata` index metric (supports wildcards)
-        # @option arguments [List] :fields A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
-        # @option arguments [Boolean] :groups A comma-separated list of search groups for `search` index metric
-        # @option arguments [String] :level Return indices stats aggregated at index, node or shard level (options: indices, node, shards)
-        # @option arguments [List] :types A comma-separated list of document types for the `indexing` index metric
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Boolean] :include_segment_file_sizes Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)
-        # @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 [String, Array] :node_id Comma-separated list of node IDs or names used to limit returned information.
+        # @option arguments [String, Array<String>] :metric Limit the information returned to the specified metrics
+        # @option arguments [String, Array<String>] :index_metric Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified.
+        # @option arguments [String, Array<String>] :completion_fields Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
+        # @option arguments [String, Array<String>] :fielddata_fields Comma-separated list or wildcard expressions of fields to include in fielddata statistics.
+        # @option arguments [String, Array<String>] :fields Comma-separated list or wildcard expressions of fields to include in the statistics.
+        # @option arguments [Boolean] :groups Comma-separated list of search groups to include in the search statistics.
+        # @option arguments [Boolean] :include_segment_file_sizes If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
+        # @option arguments [String] :level Indicates whether statistics are aggregated at the cluster, index, or shard level.
+        # @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 [Array<String>] :types A comma-separated list of document types for the indexing index metric.
+        # @option arguments [Boolean] :include_unloaded_segments If +true+, the response includes information from segments that are not loaded into memory.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-stats.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-nodes-stats
         #
         def stats(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'nodes.stats' }
 
-          defined_params = %i[node_id metric index_metric].each_with_object({}) do |variable, set_variables|
+          defined_params = [:node_id, :metric, :index_metric].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?
@@ -61,15 +63,15 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _node_id && _metric && _index_metric
-                     "_nodes/#{Utils.__listify(_node_id)}/stats/#{Utils.__listify(_metric)}/#{Utils.__listify(_index_metric)}"
+                     "_nodes/#{Utils.listify(_node_id)}/stats/#{Utils.listify(_metric)}/#{Utils.listify(_index_metric)}"
                    elsif _metric && _index_metric
-                     "_nodes/stats/#{Utils.__listify(_metric)}/#{Utils.__listify(_index_metric)}"
+                     "_nodes/stats/#{Utils.listify(_metric)}/#{Utils.listify(_index_metric)}"
                    elsif _node_id && _metric
-                     "_nodes/#{Utils.__listify(_node_id)}/stats/#{Utils.__listify(_metric)}"
+                     "_nodes/#{Utils.listify(_node_id)}/stats/#{Utils.listify(_metric)}"
                    elsif _node_id
-                     "_nodes/#{Utils.__listify(_node_id)}/stats"
+                     "_nodes/#{Utils.listify(_node_id)}/stats"
                    elsif _metric
-                     "_nodes/stats/#{Utils.__listify(_metric)}"
+                     "_nodes/stats/#{Utils.listify(_metric)}"
                    else
                      '_nodes/stats'
                    end

data/lib/elasticsearch/api/actions/nodes/usage.rb

@@ -15,26 +15,28 @@
 # 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 Nodes
       module Actions
-        # Returns low-level information about REST actions usage on nodes.
+        # Get feature usage information.
         #
-        # @option arguments [List] :node_id 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] :metric Limit the information returned to the specified metrics (options: _all, rest_actions)
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [String, Array] :node_id 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 [String, Array<String>] :metric Limits the information returned to the specific metrics.
+        #  A comma-separated list of the following options: +_all+, +rest_actions+.
+        # @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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-usage.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-nodes-usage
         #
         def usage(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'nodes.usage' }
 
-          defined_params = %i[node_id metric].each_with_object({}) do |variable, set_variables|
+          defined_params = [:node_id, :metric].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?
@@ -50,11 +52,11 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _node_id && _metric
-                     "_nodes/#{Utils.__listify(_node_id)}/usage/#{Utils.__listify(_metric)}"
+                     "_nodes/#{Utils.listify(_node_id)}/usage/#{Utils.listify(_metric)}"
                    elsif _node_id
-                     "_nodes/#{Utils.__listify(_node_id)}/usage"
+                     "_nodes/#{Utils.listify(_node_id)}/usage"
                    elsif _metric
-                     "_nodes/usage/#{Utils.__listify(_metric)}"
+                     "_nodes/usage/#{Utils.listify(_metric)}"
                    else
                      '_nodes/usage'
                    end

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

@@ -15,25 +15,56 @@
 # 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
-      # Open a point in time that can be used in subsequent searches
+      # Open a point in time.
+      # A search request by default runs against the most recent visible data of the target indices,
+      # which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the
+      # state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple
+      # search requests using the same point in time. For example, if refreshes happen between
+      # +search_after+ requests, then the results of those requests might not be consistent as changes happening
+      # between searches are only visible to the more recent point in time.
+      # A point in time must be opened explicitly before being used in search requests.
+      # A subsequent search request with the +pit+ parameter must not specify +index+, +routing+, or +preference+ values as these parameters are copied from the point in time.
+      # Just like regular searches, you can use +from+ and +size+ to page through point in time search results, up to the first 10,000 hits.
+      # If you want to retrieve more hits, use PIT with +search_after+.
+      # IMPORTANT: The open point in time request and each subsequent search request can return different identifiers; always use the most recently received ID for the next search request.
+      # When a PIT that contains shard failures is used in a search request, the missing are always reported in the search response as a +NoShardAvailableActionException+ exception.
+      # To get rid of these exceptions, a new PIT needs to be created so that shards missing from the previous PIT can be handled, assuming they become available in the meantime.
+      # **Keeping point in time alive**
+      # The +keep_alive+ parameter, which is passed to a open point in time request and search request, extends the time to live of the corresponding point in time.
+      # The value does not need to be long enough to process all data — it just needs to be long enough for the next request.
+      # Normally, the background merge process optimizes the index by merging together smaller segments to create new, bigger segments.
+      # Once the smaller segments are no longer needed they are deleted.
+      # However, open point-in-times prevent the old segments from being deleted since they are still in use.
+      # TIP: Keeping older segments alive means that more disk space and file handles are needed.
+      # Ensure that you have configured your nodes to have ample free file handles.
+      # Additionally, if a segment contains deleted or updated documents then the point in time must keep track of whether each document in the segment was live at the time of the initial search request.
+      # Ensure that your nodes have sufficient heap space if you have many open point-in-times on an index that is subject to ongoing deletes or updates.
+      # Note that a point-in-time doesn't prevent its associated indices from being deleted.
+      # You can check how many point-in-times (that is, search contexts) are open with the nodes stats API.
       #
-      # @option arguments [List] :index A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
-      # @option arguments [String] :routing Specific routing value
-      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
-      # @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] :keep_alive Specific the time to live for the point in time (*Required*)
-      # @option arguments [Boolean] :allow_partial_search_results Specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception. (default: false)
+      # @option arguments [String, Array] :index A comma-separated list of index names to open point in time; use +_all+ or empty string to perform the operation on all indices (*Required*)
+      # @option arguments [Time] :keep_alive Extend the length of time that the point in time persists. (*Required*)
+      # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  By default, it is random.
+      # @option arguments [String] :routing A custom value that is used to route operations to a specific shard.
+      # @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
+      #  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
+      #  It supports comma-separated values, such as +open,hidden+. Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
+      # @option arguments [Boolean] :allow_partial_search_results Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT.
+      #  If +false+, creating a point in time request when a shard is missing or unavailable will throw an exception.
+      #  If +true+, the point in time will contain all the shards that are available at the time of the request.
+      # @option arguments [Integer] :max_concurrent_shard_requests Maximum number of concurrent shard requests that each sub-search request executes per node. Server default: 5.
       # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body An index_filter specified with the Query DSL
+      # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/point-in-time-api.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-open-point-in-time
       #
       def open_point_in_time(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'open_point_in_time' }
@@ -48,12 +79,12 @@ module Elasticsearch
         arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
-        body   = arguments.delete(:body)
+        body = arguments.delete(:body)
 
         _index = arguments.delete(:index)
 
         method = Elasticsearch::API::HTTP_POST
-        path   = "#{Utils.__listify(_index)}/_pit"
+        path   = "#{Utils.listify(_index)}/_pit"
         params = Utils.process_params(arguments)
 
         Elasticsearch::API::Response.new(

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

@@ -15,17 +15,18 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Actions
-      # Returns whether the cluster is running.
+      # Ping the cluster.
+      # Get information about whether the cluster is running.
       #
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/index.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-cluster
       #
       def ping(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'ping' }
@@ -33,7 +34,7 @@ module Elasticsearch
         arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
-        body   = nil
+        body = nil
 
         method = Elasticsearch::API::HTTP_HEAD
         path   = ''

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

@@ -15,27 +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 Actions
-      # Creates or updates a script.
+      # Create or update a script or search template.
+      # Creates or updates a stored script or search template.
       #
-      # @option arguments [String] :id Script ID
-      # @option arguments [String] :context Script context
-      # @option arguments [Time] :timeout Explicit operation timeout
-      # @option arguments [Time] :master_timeout Specify timeout for connection to master
+      # @option arguments [String] :id The identifier for the stored script or search template.
+      #  It must be unique within the cluster. (*Required*)
+      # @option arguments [String] :context The context in which the script or search template should run.
+      #  To prevent errors, the API immediately compiles the script or template in this context.
+      # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
+      #  If no response is received before the timeout expires, the request fails and returns an error.
+      #  It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
+      # @option arguments [Time] :timeout The period to wait for a response.
+      #  If no response is received before the timeout expires, the request fails and returns an error.
+      #  It can also be set to +-1+ to indicate that the request should never timeout. Server default: 30s.
       # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body The document (*Required*)
+      # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-scripting.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-put-script
       #
       def put_script(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'put_script' }
 
-        defined_params = %i[id context].each_with_object({}) do |variable, set_variables|
+        defined_params = [:id, :context].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?
@@ -54,9 +61,9 @@ module Elasticsearch
 
         method = Elasticsearch::API::HTTP_PUT
         path   = if _id && _context
-                   "_scripts/#{Utils.__listify(_id)}/#{Utils.__listify(_context)}"
+                   "_scripts/#{Utils.listify(_id)}/#{Utils.listify(_context)}"
                  else
-                   "_scripts/#{Utils.__listify(_id)}"
+                   "_scripts/#{Utils.listify(_id)}"
                  end
         params = Utils.process_params(arguments)
 

data/lib/elasticsearch/api/actions/query_rules/delete_rule.rb

@@ -15,25 +15,27 @@
 # 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 QueryRules
       module Actions
-        # Deletes an individual query rule within a ruleset.
+        # Delete a query rule.
+        # Delete a query rule within a query ruleset.
+        # This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API.
         #
-        # @option arguments [String] :ruleset_id The unique identifier of the query ruleset this rule exists in
-        # @option arguments [String] :rule_id The unique identifier of the rule to delete.
+        # @option arguments [String] :ruleset_id The unique identifier of the query ruleset containing the rule to delete (*Required*)
+        # @option arguments [String] :rule_id The unique identifier of the query rule within the specified ruleset to delete (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-query-rule.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-delete-rule
         #
         def delete_rule(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'query_rules.delete_rule' }
 
-          defined_params = %i[ruleset_id rule_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:ruleset_id, :rule_id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -51,7 +53,7 @@ module Elasticsearch
           _rule_id = arguments.delete(:rule_id)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_query_rules/#{Utils.__listify(_ruleset_id)}/_rule/#{Utils.__listify(_rule_id)}"
+          path   = "_query_rules/#{Utils.listify(_ruleset_id)}/_rule/#{Utils.listify(_rule_id)}"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb

@@ -15,19 +15,21 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module QueryRules
       module Actions
-        # Deletes a query ruleset.
+        # Delete a query ruleset.
+        # Remove a query ruleset and its associated data.
+        # This is a destructive action that is not recoverable.
         #
-        # @option arguments [String] :ruleset_id The unique identifier of the query ruleset to delete
+        # @option arguments [String] :ruleset_id The unique identifier of the query ruleset to delete (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-query-ruleset.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-delete-ruleset
         #
         def delete_ruleset(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'query_rules.delete_ruleset' }
@@ -47,11 +49,11 @@ module Elasticsearch
           _ruleset_id = arguments.delete(:ruleset_id)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_query_rules/#{Utils.__listify(_ruleset_id)}"
+          path   = "_query_rules/#{Utils.listify(_ruleset_id)}"
           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)
               )

data/lib/elasticsearch/api/actions/query_rules/get_rule.rb

@@ -15,25 +15,26 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module QueryRules
       module Actions
-        # Returns the details about an individual query rule within a ruleset.
+        # Get a query rule.
+        # Get details about a query rule within a query ruleset.
         #
-        # @option arguments [String] :ruleset_id The unique identifier of the query ruleset the rule exists within
-        # @option arguments [String] :rule_id The unique identifier of the rule to be retrieved.
+        # @option arguments [String] :ruleset_id The unique identifier of the query ruleset containing the rule to retrieve (*Required*)
+        # @option arguments [String] :rule_id The unique identifier of the query rule within the specified ruleset to retrieve (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-query-rule.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-get-rule
         #
         def get_rule(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'query_rules.get_rule' }
 
-          defined_params = %i[ruleset_id rule_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:ruleset_id, :rule_id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -51,7 +52,7 @@ module Elasticsearch
           _rule_id = arguments.delete(:rule_id)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "_query_rules/#{Utils.__listify(_ruleset_id)}/_rule/#{Utils.__listify(_rule_id)}"
+          path   = "_query_rules/#{Utils.listify(_ruleset_id)}/_rule/#{Utils.listify(_rule_id)}"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb

@@ -15,19 +15,20 @@
 # 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 QueryRules
       module Actions
-        # Returns the details about a query ruleset.
+        # Get a query ruleset.
+        # Get details about a query ruleset.
         #
-        # @option arguments [String] :ruleset_id The unique identifier of the query ruleset
+        # @option arguments [String] :ruleset_id The unique identifier of the query ruleset (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-query-ruleset.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-get-ruleset
         #
         def get_ruleset(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'query_rules.get_ruleset' }
@@ -47,7 +48,7 @@ module Elasticsearch
           _ruleset_id = arguments.delete(:ruleset_id)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "_query_rules/#{Utils.__listify(_ruleset_id)}"
+          path   = "_query_rules/#{Utils.listify(_ruleset_id)}"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb

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

data/lib/elasticsearch/api/actions/query_rules/put_rule.rb

@@ -15,26 +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 QueryRules
       module Actions
-        # Creates or updates a query rule within a ruleset.
+        # Create or update a query rule.
+        # Create or update a query rule within a query ruleset.
+        # IMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule.
+        # It is advised to use one or the other in query rulesets, to avoid errors.
+        # Additionally, pinned queries have a maximum limit of 100 pinned hits.
+        # If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.
         #
-        # @option arguments [String] :ruleset_id The unique identifier of the ruleset this rule should be added to. The ruleset will be created if it does not exist.
-        # @option arguments [String] :rule_id The unique identifier of the rule to be created or updated.
+        # @option arguments [String] :ruleset_id The unique identifier of the query ruleset containing the rule to be created or updated. (*Required*)
+        # @option arguments [String] :rule_id The unique identifier of the query rule within the specified ruleset to be created or updated. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The query rule configuration, including the type of rule, the criteria to match the rule, and the action that should be taken if the rule matches. (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-query-rule.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-put-rule
         #
         def put_rule(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'query_rules.put_rule' }
 
-          defined_params = %i[ruleset_id rule_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:ruleset_id, :rule_id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -53,7 +58,7 @@ module Elasticsearch
           _rule_id = arguments.delete(:rule_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_query_rules/#{Utils.__listify(_ruleset_id)}/_rule/#{Utils.__listify(_rule_id)}"
+          path   = "_query_rules/#{Utils.listify(_ruleset_id)}/_rule/#{Utils.listify(_rule_id)}"
           params = {}
 
           Elasticsearch::API::Response.new(