[API] Updates source code documentation.

Updates APIs:
* bulk:
- adds list_executed_pipelines - If +true+, the response will include the ingest pipelines that were executed for each index or create.
- require_data_stream If +true+, the request's actions must target a data stream (existing or to-be-created).
* cat APIs have been streamlined, removes master_timeout, verbose options for Serverless.
* eql.search - Adds allow_partial_search_results and allow_partial_sequence_results parameters.
* indices.exists_alias, indices.get_alias - adds master_timeout parameter
* machine_learning.get_trained_models - include_model_definition parameter is deprecated! Use [include=definition] instead
* machine_learning.put_job - adds allow_no_indices, expand_wildcards, ignore_throttled and ignore_unavailable parameters

Author: picandocodigo

lib/elasticsearch-serverless/api/bulk.rb

@@ -26,6 +26,7 @@ module Actions
       # This reduces overhead and can greatly increase indexing speed.
       #
       # @option arguments [String] :index Name of the data stream, index, or index alias to perform bulk actions on.
+      # @option arguments [Boolean] :list_executed_pipelines If +true+, the response will include the ingest pipelines that were executed for each index or create.
       # @option arguments [String] :pipeline ID of the pipeline to use to preprocess incoming documents.
       #  If the index has a default ingest pipeline specified, then setting the value to +_none+ disables the default ingest pipeline for this request.
       #  If a final pipeline is configured it will always run, regardless of the value of this parameter.
@@ -39,6 +40,7 @@ module Actions
       # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation.
       #  Set to all or any positive integer up to the total number of shards in the index (+number_of_replicas+1+). Server default: 1.
       # @option arguments [Boolean] :require_alias If +true+, the request’s actions must target 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 [Hash] :headers Custom HTTP headers
       # @option arguments [String|Array] :body operations. Array of Strings, Header/Data pairs, or the conveniency "combined" format can be passed, refer to ElasticsearchServerless::API::Utils.bulkify documentation.
       #

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

@@ -29,12 +29,12 @@ module Actions
         #
         # @option arguments [String, Array<String>] :name A comma-separated list of aliases to retrieve. Supports wildcards (+*+).  To retrieve all aliases, omit this parameter or use +*+ or +_all+.
         # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
         #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
         # @option arguments [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 [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+
         #  or +:desc+ as a suffix to the column name.

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

@@ -33,12 +33,12 @@ module Actions
         #  local cluster state. If +false+ the list of selected nodes are computed
         #  from the cluster state of the master node. In both cases the coordinating
         #  node will send requests for further information to each selected node.
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
         #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
         # @option arguments [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 [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+
         #  or +:desc+ as a suffix to the column name.

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

@@ -35,7 +35,6 @@ module Actions
         # @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 [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+
         #  or +:desc+ as a suffix to the column name.

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

@@ -25,16 +25,6 @@ module Actions
         # Get CAT help.
         # Returns help for the CAT APIs.
         #
-        # @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 [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+
-        #  or +:desc+ as a suffix to the column name.
-        # @option arguments [Boolean] :v When set to +true+ will enable verbose output.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html
@@ -49,7 +39,7 @@ def help(arguments = {})
 
           method = ElasticsearchServerless::API::HTTP_GET
           path   = "_cat"
-          params = Utils.process_params(arguments)
+          params = {}
 
           ElasticsearchServerless::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -43,12 +43,12 @@ module Actions
         # @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory.
         # @option arguments [Boolean] :pri If true, the response only includes information from primary shards.
         # @option arguments [String] :time The unit used to display time values.
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
         #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
         # @option arguments [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 [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+
         #  or +:desc+ as a suffix to the column name.

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

@@ -34,13 +34,12 @@ module Actions
         # @option arguments [String, Array<String>] :h Comma-separated list of column names to display. Server default: create_time,id,state,type.
         # @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the
         #  response.
-        # @option arguments [Time] :time Unit used to display time values.
+        # @option arguments [String] :time Unit used to display time values.
         # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
         #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
         # @option arguments [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 [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+
         #  or +:desc+ as a suffix to the column name.

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

@@ -47,7 +47,6 @@ module Actions
         # @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 [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+
         #  or +:desc+ as a suffix to the column name.

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

@@ -48,7 +48,6 @@ module Actions
         # @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 [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+
         #  or +:desc+ as a suffix to the column name.

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

@@ -37,12 +37,12 @@ module Actions
         # @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases used to sort the response.
         # @option arguments [Integer] :from Skips the specified number of transforms.
         # @option arguments [Integer] :size The maximum number of transforms to display.
+        # @option arguments [String] :time Unit used to display time values.
         # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
         #  +text+, +json+, +cbor+, +yaml+, or +smile+. Server default: text.
         # @option arguments [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 [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+
         #  or +:desc+ as a suffix to the column name.

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

@@ -22,8 +22,8 @@ module ElasticsearchServerless
   module API
     module Cat
       module Actions
-        # Get transforms.
-        # Returns configuration and usage information about transforms.
+        # Get transform information.
+        # Get configuration and usage information about transforms.
         # CAT APIs are only intended for human consumption using the Kibana
         # console or command line. They are not intended for use by applications. For
         # application consumption, use the get transform statistics API.
@@ -43,7 +43,6 @@ module Actions
         # @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 [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+
         #  or +:desc+ as a suffix to the column name.

lib/elasticsearch-serverless/api/count.rb

@@ -21,7 +21,8 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # Returns number of documents matching a query.
+      # Count search results.
+      # Get the number of documents matching a query.
       #
       # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases to search.
       #  Supports wildcards (+*+).

lib/elasticsearch-serverless/api/enrich/execute_policy.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Enrich
       module Actions
-        # Creates the enrich index for an existing enrich policy.
+        # Run an enrich policy.
+        # Create the enrich index for an existing enrich policy.
         #
         # @option arguments [String] :name Enrich policy to execute. (*Required*)
         # @option arguments [Boolean] :wait_for_completion If +true+, the request blocks other enrich policy execution requests until complete. Server default: true.

lib/elasticsearch-serverless/api/eql/delete.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Eql
       module Actions
-        # Deletes an async EQL search or a stored synchronous EQL search.
+        # Delete an async EQL search.
+        # Delete an async EQL search or a stored synchronous EQL search.
         # The API also deletes results for the search.
         #
         # @option arguments [String] :id Identifier for the search to delete.

lib/elasticsearch-serverless/api/eql/get.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Eql
       module Actions
-        # Returns the current status and available results for an async EQL search or a stored synchronous EQL search.
+        # Get async EQL search results.
+        # Get the current status and available results for an async EQL search or a stored synchronous EQL search.
         #
         # @option arguments [String] :id Identifier for the search. (*Required*)
         # @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster.

lib/elasticsearch-serverless/api/eql/get_status.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Eql
       module Actions
-        # Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.
+        # Get the async EQL status.
+        # Get the current status for an async EQL search or a stored synchronous EQL search without returning results.
         #
         # @option arguments [String] :id Identifier for the search. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers

lib/elasticsearch-serverless/api/eql/search.rb

@@ -22,10 +22,15 @@ module ElasticsearchServerless
   module API
     module Eql
       module Actions
-        # Returns results matching a query expressed in Event Query Language (EQL)
+        # Get EQL search results.
+        # Returns search results for an Event Query Language (EQL) query.
+        # EQL assumes each document in a data stream or index corresponds to an event.
         #
         # @option arguments [String, Array] :index The name of the index to scope the operation (*Required*)
         # @option arguments [Boolean] :allow_no_indices [TODO] Server default: true.
+        # @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard failures. If false, returns an error with no partial results.
+        # @option arguments [Boolean] :allow_partial_sequence_results If true, sequence queries will return partial results in case of shard failures. If false, they will return no results at all.
+        #  This flag has effect only if allow_partial_search_results is true.
         # @option arguments [String, Array<String>] :expand_wildcards [TODO] Server default: open.
         # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response. Server default: true.
         # @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster. Server default: 5d.

lib/elasticsearch-serverless/api/graph/explore.rb

@@ -22,7 +22,12 @@ module ElasticsearchServerless
   module API
     module Graph
       module Actions
-        # Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.
+        # Explore graph analytics.
+        # Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
+        # The easiest way to understand the behavior of this API is to use the Graph UI to explore connections.
+        # An initial request to the +_explore+ API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.
+        # Subsequent requests enable you to spider out from one more vertices of interest.
+        # You can exclude vertices that have already been returned.
         #
         # @option arguments [String, Array] :index Name of the index. (*Required*)
         # @option arguments [String] :routing Custom value used to route operations to a specific shard.

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

@@ -35,6 +35,8 @@ module Actions
         #  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 [Time] :master_timeout 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. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html

lib/elasticsearch-serverless/api/indices/exists_index_template.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Indices
       module Actions
-        # Returns information about whether a particular index template exists.
+        # Check index templates.
+        # Check whether index templates exist.
         #
         # @option arguments [String] :name Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. (*Required*)
         # @option arguments [Time] :master_timeout 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. Server default: 30s.