elasticsearch-serverless 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bde730a1cac096779c66fa3d59c1d58c20c7134e68a2b009bb7ef5e6a9d8ae7
-  data.tar.gz: b2b1909d53c9ef64ebbf651ca0dd7b61bf409c6333840b78d4c477f4871edb87
+  metadata.gz: cdef5260655fb867303a0f21bff2a4e1cd1fbdbbdf34ce476572f41d698d5f48
+  data.tar.gz: d6eb14791d6586ea674f7c39d1aed581cc8042aee6d73f35ec48b9369aa2930b
 SHA512:
-  metadata.gz: 8b3192c5235b479cdfc5fc4b2b9e80f80c97624aad53140d37bfb066f31be1a594cea00b0e31bb5401949d5903f11856aece51f9c022d7fa33d2c9796a0e86fa
-  data.tar.gz: d94a7b20610597b151002b81fcc61a51b6b59f4eb9a7d5d714dd6e32935b6fde759c571145dd73977827a9bcb88c963d5a6645d40f4af362e22ee1784b1e5c1d
+  metadata.gz: 5b1cc8e830d266068443087c17f610f3e6a16d3ef4ac23a937d32241166a0b04568f69ed55b0dda49478e78ca8beb10d78c9c893c34b2d0c0312008d3a555c37
+  data.tar.gz: 1ee71b1b19b311b011bc4c2a4361486303011c5e058e9bc7d3dcbbfcdb62f76d7e0f4a0a501ed6c7d2dc2bf4b091e3aec7189533e55116c970a90ab19399127c

data/lib/elasticsearch-serverless/api/async_search/delete.rb

@@ -22,8 +22,8 @@ module ElasticsearchServerless
   module API
     module AsyncSearch
       module Actions
-        # Deletes an async search by identifier.
-        # If the search is still running, the search request will be cancelled.
+        # Delete an async search.
+        # If the asynchronous search is still running, it is cancelled.
         # Otherwise, the saved search results are deleted.
         # If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the +cancel_task+ cluster privilege.
         #

data/lib/elasticsearch-serverless/api/async_search/get.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module AsyncSearch
       module Actions
-        # Retrieves the results of a previously submitted async search request given its identifier.
+        # Get async search results.
+        # Retrieve the results of a previously submitted asynchronous search request.
         # If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.
         #
         # @option arguments [String] :id A unique identifier for the async search. (*Required*)

data/lib/elasticsearch-serverless/api/async_search/status.rb

@@ -22,11 +22,13 @@ module ElasticsearchServerless
   module API
     module AsyncSearch
       module Actions
-        # Get async search status
-        # Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
+        # Get the async search status.
+        # Get the status of a previously submitted async search request given its identifier, without retrieving search results.
         # If the Elasticsearch security features are enabled, use of this API is restricted to the +monitoring_user+ role.
         #
         # @option arguments [String] :id A unique identifier for the async search. (*Required*)
+        # @option arguments [Time] :keep_alive Specifies how long the async search needs to be available.
+        #  Ongoing async searches and any saved search results are deleted after this period. Server default: 5d.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
@@ -51,7 +53,7 @@ module ElasticsearchServerless
 
           method = ElasticsearchServerless::API::HTTP_GET
           path   = "_async_search/status/#{Utils.listify(_id)}"
-          params = {}
+          params = Utils.process_params(arguments)
 
           ElasticsearchServerless::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch-serverless/api/async_search/submit.rb

@@ -22,10 +22,10 @@ module ElasticsearchServerless
   module API
     module AsyncSearch
       module Actions
-        # Runs a search request asynchronously.
-        # When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
-        # Warning: Async search does not support scroll nor search requests that only include the suggest section.
-        # By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
+        # Run an async search.
+        # When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.
+        # Warning: Asynchronous search does not support scroll or search requests that include only the suggest section.
+        # By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
         # The maximum allowed size for a stored async search response can be set by changing the +search.max_async_search_response_size+ cluster level setting.
         #
         # @option arguments [String, Array] :index A comma-separated list of index names to search; use +_all+ or empty string to perform the operation on all indices
@@ -50,12 +50,10 @@ module ElasticsearchServerless
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
         # @option arguments [Integer] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
-        # @option arguments [String] :min_compatible_shard_node [TODO]
         # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
         # @option arguments [Integer] :pre_filter_shard_size The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped. Server default: 1.
         # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to true Server default: true.
         # @option arguments [String] :routing A comma-separated list of specific routing values
-        # @option arguments [Time] :scroll [TODO]
         # @option arguments [String] :search_type Search operation type
         # @option arguments [Array<String>] :stats Specific 'tag' of the request for logging and statistical purposes
         # @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit
@@ -68,7 +66,7 @@ module ElasticsearchServerless
         # @option arguments [Boolean, Integer] :track_total_hits Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.
         # @option arguments [Boolean] :track_scores Whether to calculate and return scores even if they are not used for sorting
         # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
-        # @option arguments [Boolean] :rest_total_hits_as_int [TODO]
+        # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
         # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
         # @option arguments [Boolean, String, Array<String>] :_source True or false to return the _source field or not, or a list of fields to return
         # @option arguments [String, Array<String>] :_source_excludes A list of fields to exclude from the returned _source field

data/lib/elasticsearch-serverless/api/cat/aliases.rb

@@ -34,10 +34,6 @@ module ElasticsearchServerless
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
         # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
         #  can't be combined with any other query string option.
-        # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
-        #  local cluster state. If +false+ the list of selected nodes are computed
-        #  from the cluster state of the master node. In both cases the coordinating
-        #  node will send requests for further information to each selected node.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting +:asc+

data/lib/elasticsearch-serverless/api/cat/component_templates.rb

@@ -29,15 +29,15 @@ module ElasticsearchServerless
         # They are not intended for use by applications. For application consumption, use the get component template API.
         #
         # @option arguments [String] :name The name of the component template. Accepts wildcard expressions. If omitted, all component templates are returned.
+        # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
+        #  local cluster state. If +false+ the list of selected nodes are computed
+        #  from the cluster state of the master node. In both cases the coordinating
+        #  node will send requests for further information to each selected node.
         # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
         #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
         # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
         #  can't be combined with any other query string option.
-        # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
-        #  local cluster state. If +false+ the list of selected nodes are computed
-        #  from the cluster state of the master node. In both cases the coordinating
-        #  node will send requests for further information to each selected node.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting +:asc+

data/lib/elasticsearch-serverless/api/cat/count.rb

@@ -35,10 +35,6 @@ module ElasticsearchServerless
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
         # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
         #  can't be combined with any other query string option.
-        # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
-        #  local cluster state. If +false+ the list of selected nodes are computed
-        #  from the cluster state of the master node. In both cases the coordinating
-        #  node will send requests for further information to each selected node.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting +:asc+

data/lib/elasticsearch-serverless/api/cat/help.rb

@@ -30,10 +30,6 @@ module ElasticsearchServerless
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
         # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
         #  can't be combined with any other query string option.
-        # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
-        #  local cluster state. If +false+ the list of selected nodes are computed
-        #  from the cluster state of the master node. In both cases the coordinating
-        #  node will send requests for further information to each selected node.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting +:asc+

data/lib/elasticsearch-serverless/api/cat/indices.rb

@@ -48,10 +48,6 @@ module ElasticsearchServerless
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
         # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
         #  can't be combined with any other query string option.
-        # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
-        #  local cluster state. If +false+ the list of selected nodes are computed
-        #  from the cluster state of the master node. In both cases the coordinating
-        #  node will send requests for further information to each selected node.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting +:asc+

data/lib/elasticsearch-serverless/api/cat/ml_data_frame_analytics.rb

@@ -40,10 +40,6 @@ module ElasticsearchServerless
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
         # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
         #  can't be combined with any other query string option.
-        # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
-        #  local cluster state. If +false+ the list of selected nodes are computed
-        #  from the cluster state of the master node. In both cases the coordinating
-        #  node will send requests for further information to each selected node.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting +:asc+

data/lib/elasticsearch-serverless/api/cat/ml_datafeeds.rb

@@ -47,10 +47,6 @@ module ElasticsearchServerless
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
         # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
         #  can't be combined with any other query string option.
-        # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
-        #  local cluster state. If +false+ the list of selected nodes are computed
-        #  from the cluster state of the master node. In both cases the coordinating
-        #  node will send requests for further information to each selected node.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting +:asc+

data/lib/elasticsearch-serverless/api/cat/ml_jobs.rb

@@ -48,10 +48,6 @@ module ElasticsearchServerless
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
         # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
         #  can't be combined with any other query string option.
-        # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
-        #  local cluster state. If +false+ the list of selected nodes are computed
-        #  from the cluster state of the master node. In both cases the coordinating
-        #  node will send requests for further information to each selected node.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting +:asc+

data/lib/elasticsearch-serverless/api/cat/ml_trained_models.rb

@@ -42,10 +42,6 @@ module ElasticsearchServerless
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
         # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
         #  can't be combined with any other query string option.
-        # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
-        #  local cluster state. If +false+ the list of selected nodes are computed
-        #  from the cluster state of the master node. In both cases the coordinating
-        #  node will send requests for further information to each selected node.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting +:asc+

data/lib/elasticsearch-serverless/api/cat/transforms.rb

@@ -43,10 +43,6 @@ module ElasticsearchServerless
         # @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
         # @option arguments [Boolean] :help When set to +true+ will output available columns. This option
         #  can't be combined with any other query string option.
-        # @option arguments [Boolean] :local If +true+, the request computes the list of selected nodes from the
-        #  local cluster state. If +false+ the list of selected nodes are computed
-        #  from the cluster state of the master node. In both cases the coordinating
-        #  node will send requests for further information to each selected node.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
         #  Sorting defaults to ascending and can be changed by setting +:asc+

data/lib/elasticsearch-serverless/api/clear_scroll.rb

@@ -21,7 +21,8 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Clears the search context and results for a scrolling search.
+      # Clear a scrolling search.
+      # Clear the search context and results for a scrolling search.
       #
       # @option arguments [String, Array] :scroll_id Comma-separated list of scroll IDs to clear.
       #  To clear all scroll IDs, use +_all+.
@@ -38,12 +39,6 @@ module ElasticsearchServerless
       def clear_scroll(arguments = {})
         request_opts = { endpoint: arguments[:endpoint] || "clear_scroll" }
 
-        defined_params = [:scroll_id].inject({}) do |set_variables, variable|
-          set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
-        end
-        request_opts[:defined_params] = defined_params unless defined_params.empty?
-
         arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
@@ -52,11 +47,7 @@ module ElasticsearchServerless
         _scroll_id = arguments.delete(:scroll_id)
 
         method = ElasticsearchServerless::API::HTTP_DELETE
-        path   = if _scroll_id
-                   "_search/scroll/#{Utils.listify(_scroll_id)}"
-                 else
-                   "_search/scroll"
-                 end
+        path   = "_search/scroll"
         params = Utils.process_params(arguments)
 
         if Array(arguments[:ignore]).include?(404)

data/lib/elasticsearch-serverless/api/close_point_in_time.rb

@@ -21,7 +21,11 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Closes a point-in-time.
+      # Close a point in time.
+      # A point in time must be opened explicitly before being used in search requests.
+      # The +keep_alive+ parameter tells Elasticsearch how long it should persist.
+      # A point in time is automatically closed when the +keep_alive+ period has elapsed.
+      # However, keeping points in time has a cost; close them as soon as they are no longer required for search requests.
       #
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body

data/lib/elasticsearch-serverless/api/connector/check_in.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Updates the last_seen field in the connector, and sets it to current timestamp
+        # Check in a connector.
+        # Update the +last_seen+ field in the connector and set it to the current timestamp.
         # This functionality is Experimental and may be changed or removed
         # completely in a future release. Elastic will take a best effort approach
         # to fix any issues, but experimental features are not subject to the

data/lib/elasticsearch-serverless/api/connector/delete.rb

@@ -22,7 +22,11 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Deletes a connector.
+        # Delete a connector.
+        # Removes a connector and associated sync jobs.
+        # This is a destructive action that is not recoverable.
+        # NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.
+        # These need to be removed manually.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/get.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Retrieves a connector.
+        # Get a connector.
+        # Get the details about a connector.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/list.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Returns existing connectors.
+        # Get all connectors.
+        # Get information about all connectors.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/post.rb

@@ -22,7 +22,10 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Creates a connector.
+        # Create a connector.
+        # Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure.
+        # Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud.
+        # Self-managed connectors (Connector clients) are self-managed on your infrastructure.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/put.rb

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Creates or updates a connector.
+        # Create or update a connector.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/sync_job_cancel.rb

@@ -22,7 +22,9 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Cancels a connector sync job.
+        # Cancel a connector sync job.
+        # Cancel a connector sync job, which sets the status to cancelling and updates +cancellation_requested_at+ to the current time.
+        # The connector service is then responsible for setting the status of connector sync jobs to cancelled.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/sync_job_delete.rb

@@ -22,7 +22,9 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Deletes a connector sync job.
+        # Delete a connector sync job.
+        # Remove a connector sync job and its associated data.
+        # This is a destructive action that is not recoverable.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/sync_job_get.rb

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Retrieves a connector sync job.
+        # Get a connector sync job.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/sync_job_list.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Lists connector sync jobs.
+        # Get all connector sync jobs.
+        # Get information about all stored connector sync jobs listed by their creation date in ascending order.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/sync_job_post.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Creates a connector sync job.
+        # Create a connector sync job.
+        # Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/update_active_filtering.rb

@@ -22,6 +22,7 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
+        # Activate the connector draft filter.
         # Activates the valid draft filtering for a connector.
         # This functionality is Experimental and may be changed or removed
         # completely in a future release. Elastic will take a best effort approach

data/lib/elasticsearch-serverless/api/connector/update_api_key_id.rb

@@ -22,7 +22,11 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Updates the API key id in the connector document
+        # Update the connector API key ID.
+        # Update the +api_key_id+ and +api_key_secret_id+ fields of a connector.
+        # You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored.
+        # The connector secret ID is required only for Elastic managed (native) connectors.
+        # Self-managed connectors (connector clients) do not use this field.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/update_configuration.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Updates the configuration field in the connector document
+        # Update the connector configuration.
+        # Update the configuration field in the connector document.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/update_error.rb

@@ -22,7 +22,10 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Updates the filtering field in the connector document
+        # Update the connector error field.
+        # Set the error field for the connector.
+        # If the error provided in the request body is non-null, the connector’s status is updated to error.
+        # Otherwise, if the error is reset to null, the connector status is updated to connected.
         # This functionality is Experimental and may be changed or removed
         # completely in a future release. Elastic will take a best effort approach
         # to fix any issues, but experimental features are not subject to the

data/lib/elasticsearch-serverless/api/connector/update_filtering.rb

@@ -22,7 +22,10 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Updates the filtering field in the connector document
+        # Update the connector filtering.
+        # Update the draft filtering configuration of a connector and marks the draft validation state as edited.
+        # The filtering draft is activated once validated by the running Elastic connector service.
+        # The filtering property is used to configure sync rules (both basic and advanced) for a connector.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/update_filtering_validation.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Updates the draft filtering validation info for a connector.
+        # Update the connector draft filtering validation.
+        # Update the draft filtering validation info for a connector.
         # This functionality is Experimental and may be changed or removed
         # completely in a future release. Elastic will take a best effort approach
         # to fix any issues, but experimental features are not subject to the

data/lib/elasticsearch-serverless/api/connector/update_index_name.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Updates the index_name in the connector document
+        # Update the connector index name.
+        # Update the +index_name+ field of a connector, specifying the index where the data ingested by the connector is stored.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/update_name.rb

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Updates the name and description fields in the connector document
+        # Update the connector name and description.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/update_native.rb

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Updates the is_native flag in the connector document
+        # Update the connector is_native flag.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/update_pipeline.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Updates the pipeline field in the connector document
+        # Update the connector pipeline.
+        # When you create a new connector, the configuration of an ingest pipeline is populated with default settings.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/update_scheduling.rb

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Updates the scheduling field in the connector document
+        # Update the connector scheduling.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/update_service_type.rb

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Updates the service type of the connector
+        # Update the connector service type.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support

data/lib/elasticsearch-serverless/api/connector/update_status.rb

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module Connector
       module Actions
-        # Updates the status of the connector
+        # Update the connector status.
         # This functionality is Experimental and may be changed or removed
         # completely in a future release. Elastic will take a best effort approach
         # to fix any issues, but experimental features are not subject to the

data/lib/elasticsearch-serverless/api/field_caps.rb

@@ -21,9 +21,11 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # The field capabilities API returns the information about the capabilities of fields among multiple indices.
-      # The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
-      # of keyword is returned as any other field that belongs to the +keyword+ family.
+      # Get the field capabilities.
+      # Get information about the capabilities of fields among multiple indices.
+      # For data streams, the API returns field capabilities among the stream’s backing indices.
+      # It returns runtime fields like any other field.
+      # For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the +keyword+ family.
       #
       # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.
       # @option arguments [Boolean] :allow_no_indices If false, the request returns an error if any wildcard expression, index alias,

data/lib/elasticsearch-serverless/api/indices/analyze.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Indices
       module Actions
-        # Performs analysis on a text string and returns the resulting tokens.
+        # Get tokens from text analysis.
+        # The analyze API performs {https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html analysis} on a text string and returns the resulting tokens.
         #
         # @option arguments [String] :index Index used to derive the analyzer.
         #  If specified, the +analyzer+ or field parameter overrides this value.

data/lib/elasticsearch-serverless/api/indices/exists_alias.rb

@@ -35,7 +35,6 @@ module ElasticsearchServerless
         #  Supports comma-separated values, such as +open,hidden+.
         #  Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
         # @option arguments [Boolean] :ignore_unavailable If +false+, requests that include a missing data stream or index in the target indices or data streams return an error.
-        # @option arguments [Boolean] :local If +true+, the request retrieves information from the local node only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html

data/lib/elasticsearch-serverless/api/indices/get_alias.rb

@@ -38,7 +38,6 @@ module ElasticsearchServerless
         #  Supports comma-separated values, such as +open,hidden+.
         #  Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
         # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
-        # @option arguments [Boolean] :local If +true+, the request retrieves information from the local node only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html