elasticsearch-api 8.18.0 → 9.0.1

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

@@ -15,44 +15,131 @@
 # 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 a new document in the index.
-      #
-      # Returns a 409 response when a document with a same ID already exists in the index.
+      # Create a new document in the index.
+      # You can index a new JSON document with the +/<target>/_doc/+ or +/<target>/_create/<_id>+ APIs
+      # Using +_create+ guarantees that the document is indexed only if it does not already exist.
+      # It returns a 409 response when a document with a same ID already exists in the index.
+      # To update an existing document, you must use the +/<target>/_doc/+ API.
+      # If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:
+      # * To add a document using the +PUT /<target>/_create/<_id>+ or +POST /<target>/_create/<_id>+ request formats, you must have the +create_doc+, +create+, +index+, or +write+ index privilege.
+      # * To automatically create a data stream or index with this API request, you must have the +auto_configure+, +create_index+, or +manage+ index privilege.
+      # Automatic data stream creation requires a matching index template with data stream enabled.
+      # **Automatically create data streams and indices**
+      # If the request's target doesn't exist and matches an index template with a +data_stream+ definition, the index operation automatically creates the data stream.
+      # If the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.
+      # NOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.
+      # If no mapping exists, the index operation creates a dynamic mapping.
+      # By default, new fields and objects are automatically added to the mapping if needed.
+      # Automatic index creation is controlled by the +action.auto_create_index+ setting.
+      # If it is +true+, any index can be created automatically.
+      # You can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to +false+ to turn off automatic index creation entirely.
+      # Specify a comma-separated list of patterns you want to allow or prefix each pattern with +++ or +-+ to indicate whether it should be allowed or blocked.
+      # When a list is specified, the default behaviour is to disallow.
+      # NOTE: The +action.auto_create_index+ setting affects the automatic creation of indices only.
+      # It does not affect the creation of data streams.
+      # **Routing**
+      # By default, shard placement — or routing — is controlled by using a hash of the document's ID value.
+      # For more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the +routing+ parameter.
+      # When setting up explicit mapping, you can also use the +_routing+ field to direct the index operation to extract the routing value from the document itself.
+      # This does come at the (very minimal) cost of an additional document parsing pass.
+      # If the +_routing+ mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.
+      # NOTE: Data streams do not support custom routing unless they were created with the +allow_custom_routing+ setting enabled in the template.
+      # **Distributed**
+      # The index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.
+      # After the primary shard completes the operation, if needed, the update is distributed to applicable replicas.
+      # **Active shards**
+      # To improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.
+      # If the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.
+      # By default, write operations only wait for the primary shards to be active before proceeding (that is to say +wait_for_active_shards+ is +1+).
+      # This default can be overridden in the index settings dynamically by setting +index.write.wait_for_active_shards+.
+      # To alter this behavior per operation, use the +wait_for_active_shards request+ parameter.
+      # Valid values are all or any positive integer up to the total number of configured copies per shard in the index (which is +number_of_replicas++1).
+      # Specifying a negative value or a number greater than the number of shard copies will throw an error.
+      # For example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).
+      # If you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.
+      # This means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.
+      # If +wait_for_active_shards+ is set on the request to +3+ (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.
+      # This requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.
+      # However, if you set +wait_for_active_shards+ to +all+ (or to +4+, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.
+      # The operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.
+      # It is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.
+      # After the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.
+      # The +_shards+ section of the API response reveals the number of shard copies on which replication succeeded and failed.
       #
-      # @option arguments [String] :id Document ID
-      # @option arguments [String] :index The name of the index
-      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the index 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 [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte)
-      # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
-      # @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 [String] :id A unique identifier for the document.
+      #  To automatically generate a document ID, use the +POST /<target>/_doc/+ request format. (*Required*)
+      # @option arguments [String] :index The name of the data stream or index to target.
+      #  If the target doesn't exist and matches the name or wildcard (+*+) pattern of an index template with a +data_stream+ definition, this request creates the data stream.
+      #  If the target doesn't exist and doesn’t match a data stream template, this request creates the index. (*Required*)
+      # @option arguments [Integer] :if_primary_term Only perform the operation if the document has this primary term.
+      # @option arguments [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
+      # @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. Server default: true.
+      # @option arguments [String] :op_type Set to +create+ to only index the document if it does not already exist (put if absent).
+      #  If a document with the specified +_id+ already exists, the indexing operation will fail.
+      #  The behavior is the same as using the +<index>/_create+ endpoint.
+      #  If a document ID is specified, this paramater defaults to +index+.
+      #  Otherwise, it defaults to +create+.
+      #  If the request targets a data stream, an +op_type+ of +create+ is required.
+      # @option arguments [String] :pipeline The ID of the pipeline to use to preprocess incoming documents.
+      #  If the index has a default ingest pipeline specified, setting the value to +_none+ turns off the default ingest pipeline for this request.
+      #  If a final pipeline is configured, it will always run regardless of the value of this parameter.
+      # @option arguments [String] :refresh If +true+, Elasticsearch refreshes the affected shards to make this operation visible to search.
+      #  If +wait_for+, it waits for a refresh to make this operation visible to search.
+      #  If +false+, it does nothing with refreshes. Server default: false.
+      # @option arguments [Boolean] :require_alias If +true+, the destination must be an index alias.
+      # @option arguments [Boolean] :require_data_stream If +true+, the request's actions must target a data stream (existing or to be created).
+      # @option arguments [String] :routing A custom value that is used to route operations to a specific shard.
+      # @option arguments [Time] :timeout The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.
+      #  Elasticsearch waits for at least the specified timeout period before failing.
+      #  The actual wait time could be longer, particularly when multiple waits occur.This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs.
+      #  Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation.
+      #  By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error.
+      #  The actual wait time could be longer, particularly when multiple waits occur. Server default: 1m.
+      # @option arguments [Integer] :version The explicit version number for concurrency control.
+      #  It must be a non-negative long number.
+      # @option arguments [String] :version_type The version type.
+      # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation.
+      #  You can set it to +all+ or any positive integer up to the total number of shards in the index (+number_of_replicas+1+).
+      #  The default value of +1+ means it waits for each primary shard to be active. Server default: 1.
       # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body The document (*Required*)
+      # @option arguments [Hash] :body document
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-index_.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-create
       #
       def create(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || 'create' }
 
-        defined_params = %i[index id].each_with_object({}) do |variable, set_variables|
+        defined_params = [:index, :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?
 
-        if arguments[:id]
-          index arguments.update op_type: 'create'
-        else
-          index arguments
-        end
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+        arguments = arguments.clone
+        headers = arguments.delete(:headers) || {}
+
+        body = arguments.delete(:body)
+
+        _id = arguments.delete(:id)
+
+        _index = arguments.delete(:index)
+
+        method = Elasticsearch::API::HTTP_PUT
+        path   = "#{Utils.listify(_index)}/_create/#{Utils.listify(_id)}"
+        params = Utils.process_params(arguments)
+
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers, request_opts)
+        )
       end
     end
   end

data/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb

@@ -15,20 +15,23 @@
 # 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 CrossClusterReplication
       module Actions
-        # Deletes auto-follow patterns.
+        # Delete auto-follow patterns.
+        # Delete a collection of cross-cluster replication auto-follow patterns.
         #
-        # @option arguments [String] :name The name of the auto follow pattern.
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [String] :name The auto-follow pattern collection to delete. (*Required*)
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
+        #  If the master node is not available 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
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-delete-auto-follow-pattern.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-delete-auto-follow-pattern
         #
         def delete_auto_follow_pattern(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ccr.delete_auto_follow_pattern' }
@@ -48,7 +51,7 @@ module Elasticsearch
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_ccr/auto_follow/#{Utils.__listify(_name)}"
+          path   = "_ccr/auto_follow/#{Utils.listify(_name)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb

@@ -15,22 +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 CrossClusterReplication
       module Actions
-        # Creates a new follower index configured to follow the referenced leader index.
+        # Create a follower.
+        # Create a cross-cluster replication follower index that follows a specific leader index.
+        # When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.
         #
-        # @option arguments [String] :index The name of the follower index
-        # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before returning. Defaults to 0. 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 [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [String] :index The name of the follower index. (*Required*)
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
+        # @option arguments [Integer, String] :wait_for_active_shards Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be
+        #  active.
+        #  A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the
+        #  remote Lucene segment files to the follower index.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The name of the leader index and other optional ccr related parameters (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-put-follow.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-follow
         #
         def follow(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ccr.follow' }
@@ -46,12 +51,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_PUT
-          path   = "#{Utils.__listify(_index)}/_ccr/follow"
+          path   = "#{Utils.listify(_index)}/_ccr/follow"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb

@@ -15,20 +15,24 @@
 # 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 CrossClusterReplication
       module Actions
-        # Retrieves information about all follower indices, including parameters and status for each follower index
+        # Get follower information.
+        # Get information about all cross-cluster replication follower indices.
+        # For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.
         #
-        # @option arguments [List] :index A comma-separated list of index patterns; use `_all` to perform the operation on all indices
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [String, Array] :index A comma-delimited list of follower index patterns. (*Required*)
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
+        #  If the master node is not available 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
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-follow-info.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-follow-info
         #
         def follow_info(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ccr.follow_info' }
@@ -43,12 +47,12 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "#{Utils.__listify(_index)}/_ccr/info"
+          path   = "#{Utils.listify(_index)}/_ccr/info"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb

@@ -15,20 +15,23 @@
 # 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 CrossClusterReplication
       module Actions
-        # Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.
+        # Get follower stats.
+        # Get cross-cluster replication follower stats.
+        # The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices.
         #
-        # @option arguments [List] :index A comma-separated list of index patterns; use `_all` to perform the operation on all indices
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [String, Array] :index A comma-delimited list of index patterns. (*Required*)
+        # @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. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-follow-stats.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-follow-stats
         #
         def follow_stats(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ccr.follow_stats' }
@@ -43,12 +46,12 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "#{Utils.__listify(_index)}/_ccr/stats"
+          path   = "#{Utils.listify(_index)}/_ccr/stats"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb

@@ -15,21 +15,30 @@
 # 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 CrossClusterReplication
       module Actions
-        # Removes the follower retention leases from the leader.
+        # Forget a follower.
+        # Remove the cross-cluster replication follower retention leases from the leader.
+        # A following index takes out retention leases on its leader index.
+        # These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication.
+        # When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed.
+        # However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable.
+        # While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index.
+        # This API exists to enable manually removing the leases when the unfollow API is unable to do so.
+        # NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader.
+        # The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.
         #
-        # @option arguments [String] :index the name of the leader index for which specified follower retention leases should be removed
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [String] :index the name of the leader index for which specified follower retention leases should be removed (*Required*)
+        # @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
-        # @option arguments [Hash] :body the name and UUID of the follower index, the name of the cluster containing the follower index, and the alias from the perspective of that cluster for the remote cluster containing the leader index (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-forget-follower.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-forget-follower
         #
         def forget_follower(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ccr.forget_follower' }
@@ -45,12 +54,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)}/_ccr/forget_follower"
+          path   = "#{Utils.listify(_index)}/_ccr/forget_follower"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb

@@ -15,20 +15,24 @@
 # 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 CrossClusterReplication
       module Actions
-        # Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.
+        # Get auto-follow patterns.
+        # Get cross-cluster replication auto-follow patterns.
         #
-        # @option arguments [String] :name The name of the auto follow pattern.
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [String] :name The auto-follow pattern collection that you want to retrieve.
+        #  If you do not specify a name, the API returns information for all collections.
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
+        #  If the master node is not available 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
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-auto-follow-pattern.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-get-auto-follow-pattern-1
         #
         def get_auto_follow_pattern(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ccr.get_auto_follow_pattern' }
@@ -47,7 +51,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _name
-                     "_ccr/auto_follow/#{Utils.__listify(_name)}"
+                     "_ccr/auto_follow/#{Utils.listify(_name)}"
                    else
                      '_ccr/auto_follow'
                    end

data/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb

@@ -15,20 +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 CrossClusterReplication
       module Actions
-        # Pauses an auto-follow pattern
+        # Pause an auto-follow pattern.
+        # Pause a cross-cluster replication auto-follow pattern.
+        # When the API returns, the auto-follow pattern is inactive.
+        # New indices that are created on the remote cluster and match the auto-follow patterns are ignored.
+        # You can resume auto-following with the resume auto-follow pattern API.
+        # When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns.
+        # Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.
         #
-        # @option arguments [String] :name The name of the auto follow pattern that should pause discovering new indices to follow.
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [String] :name The name of the auto-follow pattern to pause. (*Required*)
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
+        #  If the master node is not available 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
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-pause-auto-follow-pattern.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-pause-auto-follow-pattern
         #
         def pause_auto_follow_pattern(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ccr.pause_auto_follow_pattern' }
@@ -48,7 +56,7 @@ module Elasticsearch
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_ccr/auto_follow/#{Utils.__listify(_name)}/pause"
+          path   = "_ccr/auto_follow/#{Utils.listify(_name)}/pause"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb

@@ -15,20 +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 CrossClusterReplication
       module Actions
-        # Pauses a follower index. The follower index will not fetch any additional operations from the leader index.
+        # Pause a follower.
+        # Pause a cross-cluster replication follower index.
+        # The follower index will not fetch any additional operations from the leader index.
+        # You can resume following with the resume follower API.
+        # You can pause and resume a follower index to change the configuration of the following task.
         #
-        # @option arguments [String] :index The name of the follower index that should pause following its leader index.
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [String] :index The name of the follower index. (*Required*)
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
+        #  If the master node is not available 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
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-pause-follow.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-pause-follow
         #
         def pause_follow(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ccr.pause_follow' }
@@ -43,12 +49,12 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "#{Utils.__listify(_index)}/_ccr/pause_follow"
+          path   = "#{Utils.listify(_index)}/_ccr/pause_follow"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb

@@ -15,21 +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 CrossClusterReplication
       module Actions
-        # Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.
+        # Create or update auto-follow patterns.
+        # Create a collection of cross-cluster replication auto-follow patterns for a remote cluster.
+        # Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.
+        # Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.
+        # This API can also be used to update auto-follow patterns.
+        # NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.
         #
-        # @option arguments [String] :name The name of the auto follow pattern.
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [String] :name The name of the collection of auto-follow patterns. (*Required*)
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The specification of the auto follow pattern (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-put-auto-follow-pattern.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-put-auto-follow-pattern
         #
         def put_auto_follow_pattern(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ccr.put_auto_follow_pattern' }
@@ -50,7 +55,7 @@ module Elasticsearch
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_ccr/auto_follow/#{Utils.__listify(_name)}"
+          path   = "_ccr/auto_follow/#{Utils.listify(_name)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(