elasticsearch-api 8.18.0 → 9.0.1

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.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 SnapshotLifecycleManagement
       module Actions
-        # Retrieves the status of snapshot lifecycle management (SLM).
+        # Get the snapshot lifecycle management status.
         #
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @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.
+        #  To indicate that the request should never timeout, set it to +-1+. 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.
+        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-get-status.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-get-status
         #
         def get_status(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'slm.get_status' }
@@ -36,7 +40,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_GET
           path   = '_slm/status'

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb

@@ -15,22 +15,29 @@
 # 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 SnapshotLifecycleManagement
       module Actions
-        # Creates or updates a snapshot lifecycle policy.
+        # Create or update a policy.
+        # Create or update a snapshot lifecycle policy.
+        # If the policy already exists, this request increments the policy version.
+        # Only the latest version of a policy is stored.
         #
-        # @option arguments [String] :policy_id The id of the snapshot lifecycle policy
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [String] :policy_id The identifier for the snapshot lifecycle policy you want to create or update. (*Required*)
+        # @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.
+        #  To indicate that the request should never timeout, set it to +-1+. 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.
+        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The snapshot lifecycle policy definition to register
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-put-policy.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-put-lifecycle
         #
         def put_lifecycle(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'slm.put_lifecycle' }
@@ -50,7 +57,7 @@ module Elasticsearch
           _policy_id = arguments.delete(:policy_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_slm/policy/#{Utils.__listify(_policy_id)}"
+          path   = "_slm/policy/#{Utils.listify(_policy_id)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.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 SnapshotLifecycleManagement
       module Actions
-        # Turns on snapshot lifecycle management (SLM).
+        # Start snapshot lifecycle management.
+        # Snapshot lifecycle management (SLM) starts automatically when a cluster is formed.
+        # Manually starting SLM is necessary only if it has been stopped using the stop SLM API.
         #
-        # @option arguments [Time] :master_timeout Timeout for processing on master node
-        # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster
+        # @option arguments [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.
+        #  To indicate that the request should never timeout, set it to +-1+. 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.
+        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-start.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-start
         #
         def start(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'slm.start' }
@@ -36,7 +42,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_slm/start'

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb

@@ -15,20 +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 SnapshotLifecycleManagement
       module Actions
-        # Turns off snapshot lifecycle management (SLM).
+        # Stop snapshot lifecycle management.
+        # Stop all snapshot lifecycle management (SLM) operations and the SLM plugin.
+        # This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices.
+        # Stopping SLM does not stop any snapshots that are in progress.
+        # You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.
+        # The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped.
+        # Use the get snapshot lifecycle management status API to see if SLM is running.
         #
-        # @option arguments [Time] :master_timeout Timeout for processing on master node
-        # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster
+        # @option arguments [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.
+        #  To indicate that the request should never timeout, set it to +-1+. 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.
+        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/slm-api-stop.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-stop
         #
         def stop(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'slm.stop' }
@@ -36,7 +46,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_slm/stop'

data/lib/elasticsearch/api/actions/sql/clear_cursor.rb

@@ -15,19 +15,19 @@
 # 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 SQL
       module Actions
-        # Clears the SQL cursor
+        # Clear an SQL search cursor.
         #
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body Specify the cursor value in the `cursor` element to clean the cursor. (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/clear-sql-cursor-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-clear-cursor
         #
         def clear_cursor(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'sql.clear_cursor' }
@@ -37,7 +37,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_sql/close'

data/lib/elasticsearch/api/actions/sql/delete_async.rb

@@ -15,19 +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 SQL
       module Actions
-        # Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.
+        # Delete an async SQL search.
+        # Delete an async SQL search or a stored synchronous SQL search.
+        # If the search is still running, the API cancels it.
+        # If the Elasticsearch security features are enabled, only the following users can use this API to delete a search:
+        # * Users with the +cancel_task+ cluster privilege.
+        # * The user who first submitted the search.
         #
-        # @option arguments [String] :id The async search ID
+        # @option arguments [String] :id The identifier for the search. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-async-sql-search-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-delete-async
         #
         def delete_async(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'sql.delete_async' }
@@ -47,7 +52,7 @@ module Elasticsearch
           _id = arguments.delete(:id)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_sql/async/delete/#{Utils.__listify(_id)}"
+          path   = "_sql/async/delete/#{Utils.listify(_id)}"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/sql/get_async.rb

@@ -15,23 +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 SQL
       module Actions
-        # Returns the current status and available results for an async SQL search or stored synchronous SQL search
+        # Get async SQL search results.
+        # Get the current status and available results for an async SQL search or stored synchronous SQL search.
+        # If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.
         #
-        # @option arguments [String] :id The async search ID
-        # @option arguments [String] :delimiter Separator for CSV results
-        # @option arguments [String] :format Short version of the Accept header, e.g. json, yaml
-        # @option arguments [Time] :keep_alive Retention period for the search and its results
-        # @option arguments [Time] :wait_for_completion_timeout Duration to wait for complete results
+        # @option arguments [String] :id The identifier for the search. (*Required*)
+        # @option arguments [String] :delimiter The separator for CSV results.
+        #  The API supports this parameter only for CSV responses. Server default: ,.
+        # @option arguments [String] :format The format for the response.
+        #  You must specify a format using this parameter or the +Accept+ HTTP header.
+        #  If you specify both, the API uses this parameter.
+        # @option arguments [Time] :keep_alive The retention period for the search and its results.
+        #  It defaults to the +keep_alive+ period for the original SQL search.
+        # @option arguments [Time] :wait_for_completion_timeout The period to wait for complete results.
+        #  It defaults to no timeout, meaning the request waits for complete search results.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-sql-search-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-get-async
         #
         def get_async(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'sql.get_async' }
@@ -51,7 +58,7 @@ module Elasticsearch
           _id = arguments.delete(:id)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "_sql/async/#{Utils.__listify(_id)}"
+          path   = "_sql/async/#{Utils.listify(_id)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/sql/get_async_status.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 SQL
       module Actions
-        # Returns the current status of an async SQL search or a stored synchronous SQL search
+        # Get the async SQL search status.
+        # Get the current status of an async SQL search or a stored synchronous SQL search.
         #
-        # @option arguments [String] :id The async search ID
+        # @option arguments [String] :id The identifier for the search. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-sql-search-status-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-get-async-status
         #
         def get_async_status(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'sql.get_async_status' }
@@ -47,7 +48,7 @@ module Elasticsearch
           _id = arguments.delete(:id)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "_sql/async/status/#{Utils.__listify(_id)}"
+          path   = "_sql/async/status/#{Utils.listify(_id)}"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/sql/query.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 SQL
       module Actions
-        # Executes a SQL request
+        # Get SQL search results.
+        # Run an SQL request.
         #
-        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
+        # @option arguments [String] :format The format for the response.
+        #  You can also specify a format using the +Accept+ HTTP header.
+        #  If you specify both this parameter and the +Accept+ HTTP header, this parameter takes precedence.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body Use the `query` element to start a query. Use the `cursor` element to continue a query. (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/sql-search-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-query
         #
         def query(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'sql.query' }
@@ -38,7 +41,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_sql'

data/lib/elasticsearch/api/actions/sql/translate.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 SQL
       module Actions
-        # Translates SQL into Elasticsearch queries
+        # Translate SQL into Elasticsearch queries.
+        # Translate an SQL search into a search API request containing Query DSL.
+        # It accepts the same request body parameters as the SQL search API, excluding +cursor+.
         #
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body Specify the query in the `query` element. (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/sql-translate-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-translate
         #
         def translate(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'sql.translate' }
@@ -37,7 +39,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_sql/translate'

data/lib/elasticsearch/api/actions/ssl/certificates.rb

@@ -15,18 +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 SSL
       module Actions
-        # Retrieves information about the X.509 certificates used to encrypt communications in the cluster.
+        # Get SSL certificates.
+        # Get information about the X.509 certificates that are used to encrypt communications in the cluster.
+        # The API returns a list that includes certificates from all TLS contexts including:
+        # - Settings for transport and HTTP interfaces
+        # - TLS settings that are used within authentication realms
+        # - TLS settings for remote monitoring exporters
+        # The list includes certificates that are used for configuring trust, such as those configured in the +xpack.security.transport.ssl.truststore+ and +xpack.security.transport.ssl.certificate_authorities+ settings.
+        # It also includes certificates that are used for configuring server identity, such as +xpack.security.http.ssl.keystore+ and +xpack.security.http.ssl.certificate settings+.
+        # The list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch.
+        # NOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration.
+        # If Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster.
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-ssl.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ssl-certificates
         #
         def certificates(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ssl.certificates' }
@@ -34,7 +44,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_GET
           path   = '_ssl/certificates'

data/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb

@@ -15,19 +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 Synonyms
       module Actions
-        # Deletes a synonym set
+        # Delete a synonym set.
+        # You can only delete a synonyms set that is not in use by any index analyzer.
+        # Synonyms sets can be used in synonym graph token filters and synonym token filters.
+        # These synonym filters can be used as part of search analyzers.
+        # Analyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open).
+        # Even if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase.
+        # If any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available.
+        # To prevent that, synonyms sets that are used in analyzers can't be deleted.
+        # A delete request in this case will return a 400 response code.
+        # To remove a synonyms set, you must first remove all indices that contain analyzers using it.
+        # You can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data.
+        # Once finished, you can delete the index.
+        # When the synonyms set is not used in analyzers, you will be able to delete it.
         #
-        # @option arguments [String] :id The id of the synonyms set to be deleted
+        # @option arguments [String] :id The synonyms set identifier to delete. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-synonyms-set.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-delete-synonym
         #
         def delete_synonym(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'synonyms.delete_synonym' }
@@ -47,7 +59,7 @@ module Elasticsearch
           _id = arguments.delete(:id)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_synonyms/#{Utils.__listify(_id)}"
+          path   = "_synonyms/#{Utils.listify(_id)}"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/synonyms/delete_synonym_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 Synonyms
       module Actions
-        # Deletes a synonym rule in a synonym set
+        # Delete a synonym rule.
+        # Delete a synonym rule from a synonym set.
         #
-        # @option arguments [String] :set_id The id of the synonym set to be updated
-        # @option arguments [String] :rule_id The id of the synonym rule to be deleted
+        # @option arguments [String] :set_id The ID of the synonym set to update. (*Required*)
+        # @option arguments [String] :rule_id The ID of the synonym rule to delete. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-synonym-rule.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-delete-synonym-rule
         #
         def delete_synonym_rule(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'synonyms.delete_synonym_rule' }
 
-          defined_params = %i[set_id rule_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:set_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_DELETE
-          path   = "_synonyms/#{Utils.__listify(_set_id)}/#{Utils.__listify(_rule_id)}"
+          path   = "_synonyms/#{Utils.listify(_set_id)}/#{Utils.listify(_rule_id)}"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/synonyms/get_synonym.rb

@@ -15,21 +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 Synonyms
       module Actions
-        # Retrieves a synonym set
+        # Get a synonym set.
         #
-        # @option arguments [String] :id The name of the synonyms set to be retrieved
-        # @option arguments [Integer] :from Starting offset
-        # @option arguments [Integer] :size specifies a max number of results to get
+        # @option arguments [String] :id The synonyms set identifier to retrieve. (*Required*)
+        # @option arguments [Integer] :from The starting offset for query rules to retrieve. Server default: 0.
+        # @option arguments [Integer] :size The max number of query rules to retrieve. Server default: 10.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-synonyms-set.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-get-synonym
         #
         def get_synonym(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'synonyms.get_synonym' }
@@ -49,7 +49,7 @@ module Elasticsearch
           _id = arguments.delete(:id)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "_synonyms/#{Utils.__listify(_id)}"
+          path   = "_synonyms/#{Utils.listify(_id)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(