elasticsearch-serverless 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aedc93a8ab9cc3c28fe2fa52d0a4225e1e1a030c0ccd72dd1a29c003035bbdfc
-  data.tar.gz: f7c1fd06c870c37792572d51168583accc36c03b11e9b0e49c198dc0c42a1071
+  metadata.gz: 46610e7bad335976f71606b118384e4651fa882602bacbe3055e713cc16f4f63
+  data.tar.gz: 5633ddb2686aac1df293e338b885e20c0528a315a96dfeaf2bb72fa784f42e6e
 SHA512:
-  metadata.gz: 55389aab59bfd1d8958156062c455b9c017d41f9e67f52bed901bf3f16c6b319b7655553caf8dd7b2d43a2756e15c7b72f85da6e56c79937252722ce2e143cf7
-  data.tar.gz: e554159e81d7e519e9e18c600150a19d4df80dc3707fbdd6c417ba4389743b85d622b50bce66746ba5e9baa2fdc5994928c3402be5d3a8d3b90074e28a9640f7
+  metadata.gz: 14d1e876b5c56273ede725d0835ee3f35b86d3dcbc0f1147eb35d8ea8de40ce8a0cbbeec61f339b1f5e181089917294d23e03d836c2f6d12b853d9838ddb9382
+  data.tar.gz: 27d8516161d3a158cb144d9ec17ca1efaf8d130f5f1121eb2c27e500673e71c71dd382f945f55f85f065d85d6a97ecbd4e1c8fbfd42ed70cec3a6d31c93fff84

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

@@ -30,14 +30,13 @@ module ElasticsearchServerless
         # @option arguments [String] :id A unique identifier for the async search. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit
         #
         def delete(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "async_search.delete" }
+          request_opts = { endpoint: arguments[:endpoint] || 'async_search.delete' }
 
-          defined_params = [:id].inject({}) do |set_variables, variable|
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

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

@@ -27,7 +27,7 @@ module ElasticsearchServerless
         # 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*)
-        # @option arguments [Time] :keep_alive Specifies how long the async search should be available in the cluster.
+        # @option arguments [Time] :keep_alive The length of time that the async search should be available in the cluster.
         #  When not specified, the +keep_alive+ set with the corresponding submit async request will be used.
         #  Otherwise, it is possible to override the value and extend the validity of the request.
         #  When this period expires, the search, if still running, is cancelled.
@@ -38,14 +38,13 @@ module ElasticsearchServerless
         #  By default no timeout is set meaning that the currently available results will be returned without any additional wait.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit
         #
         def get(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "async_search.get" }
+          request_opts = { endpoint: arguments[:endpoint] || 'async_search.get' }
 
-          defined_params = [:id].inject({}) do |set_variables, variable|
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

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

@@ -22,21 +22,24 @@ module ElasticsearchServerless
   module API
     module AsyncSearch
       module Actions
-        # Get async search status.
-        # Retrieve 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.
+        # 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, the access to the status of a specific async search is restricted to:
+        # * The user or API key that submitted the original async search request.
+        # * Users that have the +monitor+ cluster privilege or greater privileges.
         #
         # @option arguments [String] :id A unique identifier for the async search. (*Required*)
+        # @option arguments [Time] :keep_alive The length of time that 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
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit
         #
         def status(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "async_search.status" }
+          request_opts = { endpoint: arguments[:endpoint] || 'async_search.status' }
 
-          defined_params = [:id].inject({}) do |set_variables, variable|
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -51,7 +54,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

@@ -31,9 +31,9 @@ module ElasticsearchServerless
         # @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
         # @option arguments [Time] :wait_for_completion_timeout Blocks and waits until the search is completed up to a certain timeout.
         #  When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster. Server default: 1s.
-        # @option arguments [Boolean] :keep_on_completion If +true+, results are stored for later retrieval when the search completes within the +wait_for_completion_timeout+.
         # @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 [Boolean] :keep_on_completion If +true+, results are stored for later retrieval when the search completes within the +wait_for_completion_timeout+.
         # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes +_all+ string or when no indices have been specified)
         # @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout
         # @option arguments [String] :analyzer The analyzer to use for the query string
@@ -50,12 +50,9 @@ 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 +65,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
@@ -81,14 +78,13 @@ module ElasticsearchServerless
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit
         #
         def submit(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "async_search.submit" }
+          request_opts = { endpoint: arguments[:endpoint] || 'async_search.submit' }
 
-          defined_params = [:index].inject({}) do |set_variables, variable|
+          defined_params = [:index].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -103,7 +99,7 @@ module ElasticsearchServerless
           path   = if _index
                      "#{Utils.listify(_index)}/_async_search"
                    else
-                     "_async_search"
+                     '_async_search'
                    end
           params = Utils.process_params(arguments)
 

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

@@ -22,34 +22,121 @@ module ElasticsearchServerless
   module API
     module Actions
       # Bulk index or delete documents.
-      # Performs multiple indexing or delete operations in a single API call.
+      # Perform multiple +index+, +create+, +delete+, and +update+ actions in a single request.
       # This reduces overhead and can greatly increase indexing speed.
+      # If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:
+      # * To use the +create+ action, you must have the +create_doc+, +create+, +index+, or +write+ index privilege. Data streams support only the +create+ action.
+      # * To use the +index+ action, you must have the +create+, +index+, or +write+ index privilege.
+      # * To use the +delete+ action, you must have the +delete+ or +write+ index privilege.
+      # * To use the +update+ action, you must have the +index+ or +write+ index privilege.
+      # * To automatically create a data stream or index with a bulk API request, you must have the +auto_configure+, +create_index+, or +manage+ index privilege.
+      # * To make the result of a bulk operation visible to search using the +refresh+ parameter, you must have the +maintenance+ or +manage+ index privilege.
+      # Automatic data stream creation requires a matching index template with data stream enabled.
+      # The actions are specified in the request body using a newline delimited JSON (NDJSON) structure:
+      # +
+      # action_and_meta_data\n
+      # optional_source\n
+      # action_and_meta_data\n
+      # optional_source\n
+      # ....
+      # action_and_meta_data\n
+      # optional_source\n
+      # +
+      # The +index+ and +create+ actions expect a source on the next line and have the same semantics as the +op_type+ parameter in the standard index API.
+      # A +create+ action fails if a document with the same ID already exists in the target
+      # An +index+ action adds or replaces a document as necessary.
+      # NOTE: Data streams support only the +create+ action.
+      # To update or delete a document in a data stream, you must target the backing index containing the document.
+      # An +update+ action expects that the partial doc, upsert, and script and its options are specified on the next line.
+      # A +delete+ action does not expect a source on the next line and has the same semantics as the standard delete API.
+      # NOTE: The final line of data must end with a newline character (+\n+).
+      # Each newline character may be preceded by a carriage return (+\r+).
+      # When sending NDJSON data to the +_bulk+ endpoint, use a +Content-Type+ header of +application/json+ or +application/x-ndjson+.
+      # Because this format uses literal newline characters (+\n+) as delimiters, make sure that the JSON actions and sources are not pretty printed.
+      # If you provide a target in the request path, it is used for any actions that don't explicitly specify an +_index+ argument.
+      # A note on the format: the idea here is to make processing as fast as possible.
+      # As some of the actions are redirected to other shards on other nodes, only +action_meta_data+ is parsed on the receiving node side.
+      # Client libraries using this protocol should try and strive to do something similar on the client side, and reduce buffering as much as possible.
+      # There is no "correct" number of actions to perform in a single bulk request.
+      # Experiment with different settings to find the optimal size for your particular workload.
+      # Note that Elasticsearch limits the maximum size of a HTTP request to 100mb by default so clients must ensure that no request exceeds this size.
+      # It is not possible to index a single document that exceeds the size limit, so you must pre-process any such documents into smaller pieces before sending them to Elasticsearch.
+      # For instance, split documents into pages or chapters before indexing them, or store raw binary data in a system outside Elasticsearch and replace the raw data with a link to the external system in the documents that you send to Elasticsearch.
+      # **Client suppport for bulk requests**
+      # Some of the officially supported clients provide helpers to assist with bulk requests and reindexing:
+      # * Go: Check out +esutil.BulkIndexer+
+      # * Perl: Check out +Search::Elasticsearch::Client::5_0::Bulk+ and +Search::Elasticsearch::Client::5_0::Scroll+
+      # * Python: Check out +elasticsearch.helpers.*+
+      # * JavaScript: Check out +client.helpers.*+
+      # * .NET: Check out +BulkAllObservable+
+      # * PHP: Check out bulk indexing.
+      # **Submitting bulk requests with cURL**
+      # If you're providing text file input to +curl+, you must use the +--data-binary+ flag instead of plain +-d+.
+      # The latter doesn't preserve newlines. For example:
+      # +
+      # $ cat requests
+      # { "index" : { "_index" : "test", "_id" : "1" } }
+      # { "field1" : "value1" }
+      # $ curl -s -H "Content-Type: application/x-ndjson" -XPOST localhost:9200/_bulk --data-binary "@requests"; echo
+      # {"took":7, "errors": false, "items":[{"index":{"_index":"test","_id":"1","_version":1,"result":"created","forced_refresh":false}}]}
+      # +
+      # **Optimistic concurrency control**
+      # Each +index+ and +delete+ action within a bulk API call may include the +if_seq_no+ and +if_primary_term+ parameters in their respective action and meta data lines.
+      # The +if_seq_no+ and +if_primary_term+ parameters control how operations are run, based on the last modification to existing documents. See Optimistic concurrency control for more details.
+      # **Versioning**
+      # Each bulk item can include the version value using the +version+ field.
+      # It automatically follows the behavior of the index or delete operation based on the +_version+ mapping.
+      # It also support the +version_type+.
+      # **Routing**
+      # Each bulk item can include the routing value using the +routing+ field.
+      # It automatically follows the behavior of the index or delete operation based on the +_routing+ mapping.
+      # NOTE: Data streams do not support custom routing unless they were created with the +allow_custom_routing+ setting enabled in the template.
+      # **Wait for active shards**
+      # When making bulk calls, you can set the +wait_for_active_shards+ parameter to require a minimum number of shard copies to be active before starting to process the bulk request.
+      # **Refresh**
+      # Control when the changes made by this request are visible to search.
+      # NOTE: Only the shards that receive the bulk request will be affected by refresh.
+      # Imagine a +_bulk?refresh=wait_for+ request with three documents in it that happen to be routed to different shards in an index with five shards.
+      # The request will only wait for those three shards to refresh.
+      # The other two shards that make up the index do not participate in the +_bulk+ request at all.
       #
-      # @option arguments [String] :index Name of the data stream, index, or index alias to perform bulk actions on.
-      # @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.
-      # @option arguments [String] :refresh If +true+, Elasticsearch refreshes the affected shards to make this operation visible to search, if +wait_for+ then wait for a refresh to make this operation visible to search, if +false+ do nothing with refreshes.
+      # @option arguments [String] :index The name of the data stream, index, or index alias to perform bulk actions on.
+      # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Server default: true.
+      # @option arguments [Boolean] :list_executed_pipelines If +true+, the response will include the ingest pipelines that were run for each index or create.
+      # @option arguments [String] :pipeline The pipeline identifier to use to preprocess incoming documents.
+      #  If the index has a default ingest pipeline specified, setting the value to +_none+ turns off the default ingest pipeline for this request.
+      #  If a final pipeline is configured, it will always run regardless of the value of this parameter.
+      # @option arguments [String] :refresh If +true+, Elasticsearch refreshes the affected shards to make this operation visible to search.
+      #  If +wait_for+, wait for a refresh to make this operation visible to search.
+      #  If +false+, do nothing with refreshes.
       #  Valid values: +true+, +false+, +wait_for+. Server default: false.
-      # @option arguments [String] :routing Custom value used to route operations to a specific shard.
-      # @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] :routing A custom value that is used to route operations to a specific shard.
+      # @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the +_source+ field (+true+ or +false+) or contains a list of fields to return.
       # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
+      #  You can also use this parameter to exclude fields from the subset specified in +_source_includes+ query parameter.
+      #  If the +_source+ parameter is +false+, this parameter is ignored.
       # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
-      # @option arguments [Time] :timeout Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. Server default: 1m.
+      #  If this parameter is specified, only these source fields are returned.
+      #  You can exclude fields from this subset using the +_source_excludes+ query parameter.
+      #  If the +_source+ parameter is +false+, this parameter is ignored.
+      # @option arguments [Time] :timeout The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards.
+      #  The default is +1m+ (one minute), which guarantees Elasticsearch waits for at least the timeout before failing.
+      #  The actual wait time could be longer, particularly when multiple waits occur. Server default: 1m.
       # @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.
+      #  Set to +all+ or any positive integer up to the total number of shards in the index (+number_of_replicas+1+).
+      #  The default is +1+, which waits for each primary shard to be active. 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.
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk
       #
       def bulk(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "bulk" }
+        request_opts = { endpoint: arguments[:endpoint] || 'bulk' }
 
-        defined_params = [:index].inject({}) do |set_variables, variable|
+        defined_params = [:index].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -66,17 +153,17 @@ module ElasticsearchServerless
         path   = if _index
                    "#{Utils.listify(_index)}/_bulk"
                  else
-                   "_bulk"
+                   '_bulk'
                  end
         params = Utils.process_params(arguments)
 
-        if body.is_a? Array
-          payload = ElasticsearchServerless::API::Utils.bulkify(body)
-        else
-          payload = body
-        end
+        payload = if body.is_a? Array
+                    ElasticsearchServerless::API::Utils.bulkify(body)
+                  else
+                    body
+                  end
 
-        headers.merge!("Content-Type" => "application/x-ndjson")
+        headers.merge!('Content-Type' => 'application/x-ndjson')
         ElasticsearchServerless::API::Response.new(
           perform_request(method, path, params, payload, headers, request_opts)
         )

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

@@ -23,36 +23,35 @@ module ElasticsearchServerless
     module Cat
       module Actions
         # Get aliases.
-        # Retrieves the cluster’s index aliases, including filter and routing information.
-        # The API does not return data stream aliases.
-        # CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.
+        # Get the cluster's index aliases, including filter and routing information.
+        # This API does not return data stream aliases.
+        # IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.
         #
         # @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 [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+
         #  or +:desc+ as a suffix to the column name.
+        # @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
+        #  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
+        #  It supports comma-separated values, such as +open,hidden+.
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
+        #  If the master node is not available before the timeout expires, the request fails and returns an error.
+        #  To indicated that the request should never timeout, you can set it to +-1+. 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 [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] :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-alias.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases
         #
         def aliases(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "cat.aliases" }
+          request_opts = { endpoint: arguments[:endpoint] || 'cat.aliases' }
 
-          defined_params = [:name].inject({}) do |set_variables, variable|
+          defined_params = [:name].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -67,7 +66,7 @@ module ElasticsearchServerless
           path   = if _name
                      "_cat/aliases/#{Utils.listify(_name)}"
                    else
-                     "_cat/aliases"
+                     '_cat/aliases'
                    end
           params = Utils.process_params(arguments)
           params[:h] = Utils.listify(params[:h]) if params[:h]

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

@@ -23,36 +23,37 @@ module ElasticsearchServerless
     module Cat
       module Actions
         # Get component templates.
-        # Returns information about component templates in a cluster.
+        # Get information about component templates in a cluster.
         # Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
-        # CAT APIs are only intended for human consumption using the command line or Kibana console.
+        # IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.
         # 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 [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] :name The name of the component template.
+        #  It accepts wildcard expressions.
+        #  If it is omitted, all component templates are returned.
         # @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 [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] :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+
-        #  or +:desc+ as a suffix to the column name.
+        # @option arguments [Time] :master_timeout The 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 [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] :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/master/cat-component-templates.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates
         #
         def component_templates(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "cat.component_templates" }
+          request_opts = { endpoint: arguments[:endpoint] || 'cat.component_templates' }
 
-          defined_params = [:name].inject({}) do |set_variables, variable|
+          defined_params = [:name].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -67,7 +68,7 @@ module ElasticsearchServerless
           path   = if _name
                      "_cat/component_templates/#{Utils.listify(_name)}"
                    else
-                     "_cat/component_templates"
+                     '_cat/component_templates'
                    end
           params = Utils.process_params(arguments)
 

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

@@ -23,37 +23,32 @@ module ElasticsearchServerless
     module Cat
       module Actions
         # Get a document count.
-        # Provides quick access to a document count for a data stream, an index, or an entire cluster.
+        # Get quick access to a document count for a data stream, an index, or an entire cluster.
         # The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.
-        # CAT APIs are only intended for human consumption using the command line or Kibana console.
+        # IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.
         # They are not intended for use by applications. For application consumption, use the count API.
         #
-        # @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 [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] :index A comma-separated list of data streams, indices, and aliases used to limit the request.
+        #  It supports wildcards (+*+).
+        #  To target all data streams and indices, omit this parameter or use +*+ or +_all+.
         # @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+
         #  or +:desc+ as a suffix to the column name.
+        # @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 [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] :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-count.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count
         #
         def count(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "cat.count" }
+          request_opts = { endpoint: arguments[:endpoint] || 'cat.count' }
 
-          defined_params = [:index].inject({}) do |set_variables, variable|
+          defined_params = [:index].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -68,7 +63,7 @@ module ElasticsearchServerless
           path   = if _index
                      "_cat/count/#{Utils.listify(_index)}"
                    else
-                     "_cat/count"
+                     '_cat/count'
                    end
           params = Utils.process_params(arguments)
           params[:h] = Utils.listify(params[:h]) if params[:h]

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

@@ -23,28 +23,14 @@ module ElasticsearchServerless
     module Cat
       module Actions
         # Get CAT help.
-        # Returns help for the CAT APIs.
+        # Get 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 [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+
-        #  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
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cat
         #
         def help(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "cat.help" }
+          request_opts = { endpoint: arguments[:endpoint] || 'cat.help' }
 
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
@@ -52,8 +38,8 @@ module ElasticsearchServerless
           body = nil
 
           method = ElasticsearchServerless::API::HTTP_GET
-          path   = "_cat"
-          params = Utils.process_params(arguments)
+          path   = '_cat'
+          params = {}
 
           ElasticsearchServerless::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)