opensearch-ruby 4.0.0.pre.beta.2 → 4.0.0.pre.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd0ba003344de903355ff8dd05b673bbbf5cde0ad186aa3cca4c5e15061496a9
-  data.tar.gz: 8dfd4d4dd95e03d90739d69674fda5ed305542318be5195064fa4d876e65ffd9
+  metadata.gz: 52165e3bcc6883923f6bbfc57aeaf73b0cd9d054983804de6432baece83483ee
+  data.tar.gz: 0eb577153a23b0d91f091e901e8a209b6a880da271a5e426a27586bdccaa2710
 SHA512:
-  metadata.gz: a362e94319b0c1d3ff770af2a2f2b6917da87fdf8223e5389a25e3e997c2635a9fbdb114ab30c711415626e81df8ac5d0d7f34d5712ac6d1a67163187d8b9efe
-  data.tar.gz: 54ec61d9ae890eca45e4bff96c4d457732a5f318e78bf7881abd39482b03dc2c9776a3375e80f99ba0fbd281ab5e337c87cf7ab53f558a89bffc276a291c5dc7
+  metadata.gz: 900fd3c53f3b222fece0968e1094a87f5ce2cd6a7174d8a54470d74a19af5db6982351459d5efdedd03545ac824123daefb2373ae109a263fca50bbd755ba357
+  data.tar.gz: c72d67452b64da318baf2d9f71b2aff32ebb7c0e6f1eb493b5c91ddd7ab3b54590108b56dcc2ce5a705868cbf2c7772742029d55a85629de7a42cea129ce52e2

data/USER_GUIDE.md

@@ -3,6 +3,7 @@
   - [Basic Usage](#basic-usage)
   - [OpenSearch DSL](#opensearch-dsl)
   - [Guides by Topics](#guides-by-topics)
+  - [Using a Request Signer](#using-a-request-signer)
   - [Amazon OpenSearch Service](#amazon-opensearch-service)
 
 # User Guide
@@ -24,12 +25,12 @@ bundle install
 Import the client:
 
 ```ruby
-require 'opensearch'
+require 'opensearch-ruby'
 ```
 
 ## Basic Usage
 ```ruby
-require 'opensearch'
+require 'opensearch-ruby'
 
 client = OpenSearch::Client.new(
   host: 'https://localhost:9200',
@@ -114,8 +115,8 @@ puts response
 The `opensearch-dsl` library is designed as a group of standalone Ruby modules, classes and DSL methods, which provide an idiomatic way to build complex search definitions
 
 ```ruby
-require 'opensearch'
-require 'opensearch/dsl'
+require 'opensearch-ruby'
+require 'opensearch-dsl'
 include OpenSearch::DSL
 
 response = client.search index: index_name, body: search {
@@ -142,8 +143,25 @@ response = client.search index: index_name, body: search {
 - [Transport Options](guides/transport_options.md)
 - [Custom HTTP Requests](guides/json.md)
 
+
+## Using a Request Signer
+The OpenSearch ruby client supports request signing as an authentication mechanism. When instantiating a client, you can pass a request signer object to sign requests. This object is often created via a 3rd party library such as `opensearch-aws-sigv4`, but you can also create your own (Check the [DEVELOPER_GUIDE](./DEVELOPER_GUIDE.md) for more details). Below is a very simple example of a request signer object that simply signs the request with a timestamp:
+
+```ruby
+require 'opensearch-ruby'
+
+client = OpenSearch::Client.new(
+  host: 'https://localhost:9200',
+  request_signer: Struct.new(:signer) do
+    def self.sign_request(**args)
+      args[:headers].merge({ 'X-signature' => Time.now.utc })
+    end
+  end
+)
+```
+
 ## Amazon OpenSearch Service
 
-Requests to [OpenSearch Service and OpenSearch Serverless](https://docs.aws.amazon.com/opensearch-service/index.html) must be signed using the AWS signing protocol. Use `opensearch-aws-sigv4` gem in place of `opensearch-ruby` gem.
+Requests to [OpenSearch Service and OpenSearch Serverless](https://docs.aws.amazon.com/opensearch-service/index.html) must be signed using the AWS signing protocol. The `opensearch-aws-sigv4` gem provides a request signer object that can be passed to the `OpenSearch::Client` during instantiation to sign requests.
 
 For more information, checkout the [USER_GUIDE](https://github.com/opensearch-project/opensearch-ruby-aws-sigv4/blob/main/USER_GUIDE.md) of [opensearch-aws-sigv4 gem](https://github.com/opensearch-project/opensearch-ruby-aws-sigv4).

data/lib/opensearch/api/actions/cluster/allocation_explain.rb

@@ -16,7 +16,7 @@ module OpenSearch
         # Explains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node.
         #
         # @option args [Boolean] :include_disk_info When `true`, returns information about disk usage and shard sizes.
-        # @option args [Boolean] :include_yes_decisions When `true`, returns any `YES` decisions in the allocation explanation.
+        # @option args [Boolean] :include_yes_decisions When `true`, returns any `YES` decisions in the allocation explanation. `YES` decisions indicate when a particular shard allocation attempt was successful for the given node.
         # @option args [Hash] :body The index, shard, and primary flag for which to generate an explanation. Leave this empty to generate an explanation for the first unassigned shard.
         def allocation_explain(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/cluster/delete_component_template.rb

@@ -16,7 +16,7 @@ module OpenSearch
         # Deletes a component template.
         #
         # @option args [String] :name *Required* The name of the component template to delete. Supports wildcard (*) expressions.
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
         # @option args [String] :master_timeout DEPRECATED A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
         # @option args [String] :timeout A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
         def delete_component_template(args = {})

data/lib/opensearch/api/actions/cluster/exists_component_template.rb

@@ -16,7 +16,7 @@ module OpenSearch
         # Returns information about whether a particular component template exist.
         #
         # @option args [String] :name *Required* The name of the component template. Wildcard (*) expressions are supported.
-        # @option args [String] :cluster_manager_timeout A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
         # @option args [Boolean] :local When `true`, the request retrieves information from the local node only. When `false, information is retrieved from the cluster manager node.
         # @option args [String] :master_timeout DEPRECATED A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
         def exists_component_template(args = {})

data/lib/opensearch/api/actions/cluster/get_component_template.rb

@@ -15,8 +15,8 @@ module OpenSearch
       module Actions
         # Returns one or more component templates.
         #
-        # @option args [String] :cluster_manager_timeout A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
-        # @option args [Boolean] :flat_settings If `true`, returns settings in flat format.
+        # @option args [String] :cluster_manager_timeout (default: 30s) The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
+        # @option args [Boolean] :flat_settings Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of `"cluster": { "max_shards_per_node": 500 }` is `"cluster.max_shards_per_node": "500"`.
         # @option args [Boolean] :local When `true`, the request retrieves information from the local node only. When `false`, information is retrieved from the cluster manager node.
         # @option args [String] :master_timeout DEPRECATED A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
         # @option args [String] :name The name of the component template to retrieve. Wildcard (`*`) expressions are supported.

data/lib/opensearch/api/actions/cluster/get_settings.rb

@@ -15,8 +15,8 @@ module OpenSearch
       module Actions
         # Returns cluster settings.
         #
-        # @option args [String] :cluster_manager_timeout A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
-        # @option args [Boolean] :flat_settings When `true`, returns cluster settings in a flat format.
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
+        # @option args [Boolean] :flat_settings Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of `"cluster": { "max_shards_per_node": 500 }` is `"cluster.max_shards_per_node": "500"`.
         # @option args [Boolean] :include_defaults When `true`, returns default cluster settings from the local node.
         # @option args [String] :master_timeout DEPRECATED A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
         # @option args [String] :timeout A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

data/lib/opensearch/api/actions/cluster/health.rb

@@ -16,13 +16,13 @@ module OpenSearch
         # Returns basic information about the health of the cluster.
         #
         # @option args [String] :awareness_attribute The name of the awareness attribute for which to return the cluster health status (for example, `zone`). Applicable only if `level` is set to `awareness_attributes`.
-        # @option args [String] :cluster_manager_timeout A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
-        # @option args [Enumerable<String>, String] :expand_wildcards Specifies the type of index that wildcard expressions can match. Supports comma-separated values.
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
+        # @option args [Enumerable<String>, String] :expand_wildcards (default: open) Specifies the type of index that wildcard expressions can match. Supports comma-separated values.
         # @option args [String] :level (default: cluster) Controls the amount of detail included in the cluster health response.
         # @option args [Boolean] :local Whether to return information from the local node only instead of from the cluster manager node.
         # @option args [String] :master_timeout DEPRECATED A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
-        # @option args [String] :timeout A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
-        # @option args [Integer, String] :wait_for_active_shards Waits until the specified number of shards is active before returning a response. Use `all` for all shards.
+        # @option args [String] :timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
+        # @option args [Integer, String] :wait_for_active_shards (default: 0) Waits until the specified number of shards is active before returning a response. Use `all` for all shards.
         # @option args [String] :wait_for_events Waits until all currently queued events with the given priority are processed.
         # @option args [Boolean] :wait_for_no_initializing_shards Whether to wait until there are no initializing shards in the cluster.
         # @option args [Boolean] :wait_for_no_relocating_shards Whether to wait until there are no relocating shards in the cluster.

data/lib/opensearch/api/actions/cluster/pending_tasks.rb

@@ -16,7 +16,7 @@ module OpenSearch
         # Returns a list of pending cluster-level tasks, such as index creation, mapping updates,
         # or new allocations.
         #
-        # @option args [String] :cluster_manager_timeout A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
         # @option args [Boolean] :local When `true`, the request retrieves information from the local node only. When `false`, information is retrieved from the cluster manager node.
         # @option args [String] :master_timeout DEPRECATED A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
         def pending_tasks(args = {})

data/lib/opensearch/api/actions/cluster/post_voting_config_exclusions.rb

@@ -15,8 +15,8 @@ module OpenSearch
       module Actions
         # Updates the cluster voting configuration by excluding certain node IDs or names.
         #
-        # @option args [Enumerable<String>, String] :node_ids A comma-separated list of node IDs to exclude from the voting configuration. When using this setting, you cannot also specify `node_names`.
-        # @option args [Enumerable<String>, String] :node_names A comma-separated list of node names to exclude from the voting configuration. When using this setting, you cannot also specify `node_ids`.
+        # @option args [Enumerable<String>, String] :node_ids A comma-separated list of node IDs to exclude from the voting configuration. When using this setting, you cannot also specify `node_names`. Either `node_ids` or `node_names` are required to receive a valid response.
+        # @option args [Enumerable<String>, String] :node_names A comma-separated list of node names to exclude from the voting configuration. When using this setting, you cannot also specify `node_ids`. Either `node_ids` or `node_names` are required to receive a valid response.
         # @option args [String] :timeout When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning a response. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error.
         def post_voting_config_exclusions(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/cluster/put_component_template.rb

@@ -15,8 +15,8 @@ module OpenSearch
       module Actions
         # Creates or updates a component template.
         #
-        # @option args [String] :name *Required* The name of the component template to create. OpenSearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; `metrics-mappings`; `metrics-settings`; `synthetics-mapping`; `synthetics-settings`. OpenSearch uses these templates to configure backing indexes for its data streams. If you want to overwrite one of these templates, set the replacement template `version` to a higher value than the current version. If you want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the Cluster Update Settings API.
-        # @option args [String] :cluster_manager_timeout A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
+        # @option args [String] :name *Required* The name of the component template to create. OpenSearch includes the following built-in component templates: `logs-mappings`, `logs-settings`, `metrics-mappings`, `metrics-settings`, `synthetics-mapping`, and `synthetics-settings`. OpenSearch uses these templates to configure backing indexes for its data streams. If you want to overwrite one of these templates, set the replacement template `version` to a higher value than the current version. If you want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the [Cluster Update Settings API](https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/).
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
         # @option args [Boolean] :create When `true`, this request cannot replace or update existing component templates.
         # @option args [String] :master_timeout DEPRECATED A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
         # @option args [String] :timeout A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

data/lib/opensearch/api/actions/cluster/put_decommission_awareness.rb

@@ -16,7 +16,7 @@ module OpenSearch
         # Decommissions a cluster zone based on awareness. This can greatly benefit multi-zone deployments, where awareness attributes can aid in applying new upgrades to a cluster in a controlled fashion.
         #
         # @option args [String] :awareness_attribute_name *Required* The name of the awareness attribute.
-        # @option args [String] :awareness_attribute_value *Required* The value of the awareness attribute.
+        # @option args [String] :awareness_attribute_value *Required* The value of the awareness attribute. For example, if you have shards allocated in two different zones, you can give each zone a value of `zone-a` or `zoneb`. The cluster decommission operation decommissions the zone listed in the method.
         def put_decommission_awareness(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'awareness_attribute_name' missing" if args['awareness_attribute_name'].nil?

data/lib/opensearch/api/actions/cluster/put_settings.rb

@@ -15,8 +15,8 @@ module OpenSearch
       module Actions
         # Updates the cluster settings.
         #
-        # @option args [String] :cluster_manager_timeout A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
-        # @option args [Boolean] :flat_settings Returns settings in a flat format.
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
+        # @option args [Boolean] :flat_settings Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of `"cluster": { "max_shards_per_node": 500 }` is `"cluster.max_shards_per_node": "500"`.
         # @option args [String] :master_timeout DEPRECATED A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
         # @option args [String] :timeout A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
         # @option args [Hash] :body *Required* The cluster settings to update.

data/lib/opensearch/api/actions/cluster/put_weighted_routing.rb

@@ -15,7 +15,7 @@ module OpenSearch
       module Actions
         # Updates weighted shard routing weights.
         #
-        # @option args [String] :attribute *Required* The name of the awareness attribute.
+        # @option args [String] :attribute *Required* The name of awareness attribute, usually `zone`.
         # @option args [Hash] :body
         def put_weighted_routing(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/cluster/reroute.rb

@@ -15,9 +15,9 @@ module OpenSearch
       module Actions
         # Allows to manually change the allocation of individual shards in the cluster.
         #
-        # @option args [String] :cluster_manager_timeout A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
         # @option args [Boolean] :dry_run When `true`, the request simulates the operation and returns the resulting state.
-        # @option args [Boolean] :explain When `true`, the response contains an explanation of why certain commands can or cannot be executed.
+        # @option args [Boolean] :explain When `true`, the response contains an explanation of why reroute certain commands can or cannot be executed.
         # @option args [String] :master_timeout DEPRECATED A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
         # @option args [Enumerable<String>, String] :metric Limits the information returned to the specified metrics.
         # @option args [Boolean] :retry_failed When `true`, retries shard allocation if it was blocked because of too many subsequent failures.

data/lib/opensearch/api/actions/cluster/state.rb

@@ -16,15 +16,15 @@ module OpenSearch
         # Returns comprehensive information about the state of the cluster.
         #
         # @option args [Boolean] :allow_no_indices Whether to ignore a wildcard index expression that resolves into no concrete indexes. This includes the `_all` string or when no indexes have been specified.
-        # @option args [String] :cluster_manager_timeout A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
         # @option args [Enumerable<String>, String] :expand_wildcards Specifies the type of index that wildcard expressions can match. Supports comma-separated values.
-        # @option args [Boolean] :flat_settings Returns settings in a flat format.
+        # @option args [Boolean] :flat_settings Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of `"cluster": { "max_shards_per_node": 500 }` is `"cluster.max_shards_per_node": "500"`.
         # @option args [Boolean] :ignore_unavailable Whether the specified concrete indexes should be ignored when unavailable (missing or closed).
         # @option args [Boolean] :local Whether to return information from the local node only instead of from the cluster manager node.
         # @option args [String] :master_timeout DEPRECATED A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
         # @option args [Integer] :wait_for_metadata_version Wait for the metadata version to be equal or greater than the specified metadata version.
         # @option args [String] :wait_for_timeout The maximum time to wait for `wait_for_metadata_version` before timing out.
-        # @option args [Enumerable<String>] :metric Limits the information returned to only the specified metrics.
+        # @option args [Enumerable<String>] :metric Limits the information returned to only the [specified metric groups](https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/#metric-groups).
         # @option args [Enumerable<String>, String] :index A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`.
         def state(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/cluster/stats.rb

@@ -15,9 +15,9 @@ module OpenSearch
       module Actions
         # Returns a high-level overview of cluster statistics.
         #
-        # @option args [Boolean] :flat_settings When `true`, returns settings in a flat format.
+        # @option args [Boolean] :flat_settings Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of `"cluster": { "max_shards_per_node": 500 }` is `"cluster.max_shards_per_node": "500"`.
         # @option args [String] :timeout The amount of time to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response's `_nodes.failed` property. Defaults to no timeout.
-        # @option args [Enumerable<String>] :index_metric A comma-separated list of index metric groups, for example, `docs,store`.
+        # @option args [Enumerable<String>] :index_metric A comma-separated list of [index metric groups](https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/#index-metric-groups), for example, `docs,store`.
         # @option args [Enumerable<String>] :metric Limit the information returned to the specified metrics.
         # @option args [Enumerable<String>, String] :node_id A comma-separated list of node IDs used to filter results. Supports [node filters](https://opensearch.org/docs/latest/api-reference/nodes-apis/index/#node-filters).
         def stats(args = {})

data/lib/opensearch/api/actions/ingest/delete_pipeline.rb

@@ -13,12 +13,12 @@ module OpenSearch
   module API
     module Ingest
       module Actions
-        # Deletes a pipeline.
+        # Deletes an ingest pipeline.
         #
-        # @option args [String] :id *Required* Pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of `*`.
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :id *Required* The pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of `*`.
+        # @option args [String] :cluster_manager_timeout The amount of time allowed to establish a connection to the cluster manager node.
         # @option args [String] :master_timeout DEPRECATED Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.
-        # @option args [String] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
+        # @option args [String] :timeout The amount of time to wait for a response.
         def delete_pipeline(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?

data/lib/opensearch/api/actions/ingest/get_pipeline.rb

@@ -13,11 +13,11 @@ module OpenSearch
   module API
     module Ingest
       module Actions
-        # Returns a pipeline.
+        # Returns an ingest pipeline.
         #
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :cluster_manager_timeout The amount of time allowed to establish a connection to the cluster manager node.
         # @option args [String] :master_timeout DEPRECATED Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.
-        # @option args [String] :id Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`.
+        # @option args [String] :id A comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`.
         def get_pipeline(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           _id = args.delete('id')

data/lib/opensearch/api/actions/ingest/processor_grok.rb

@@ -13,9 +13,9 @@ module OpenSearch
   module API
     module Ingest
       module Actions
-        # Returns a list of the built-in patterns.
+        # Returns a list of built-in grok patterns.
         #
-        # @option args [Boolean] :s Sort returned patterns by key name.
+        # @option args [Boolean] :s Determines how to sort returned grok patterns by key name.
         def processor_grok(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}

data/lib/opensearch/api/actions/ingest/put_pipeline.rb

@@ -13,13 +13,13 @@ module OpenSearch
   module API
     module Ingest
       module Actions
-        # Creates or updates a pipeline.
+        # Creates or updates an ingest pipeline.
         #
-        # @option args [String] :id *Required* ID of the ingest pipeline to create or update.
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :id *Required* The ID of the ingest pipeline.
+        # @option args [String] :cluster_manager_timeout The amount of time allowed to establish a connection to the cluster manager node.
         # @option args [String] :master_timeout DEPRECATED Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.
-        # @option args [String] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
-        # @option args [Hash] :body *Required* The ingest definition
+        # @option args [String] :timeout The amount of time to wait for a response.
+        # @option args [Hash] :body *Required* The ingest definition.
         def put_pipeline(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?

data/lib/opensearch/api/actions/ingest/simulate.rb

@@ -13,10 +13,10 @@ module OpenSearch
   module API
     module Ingest
       module Actions
-        # Allows to simulate a pipeline with example documents.
+        # Simulates an ingest pipeline with example documents.
         #
-        # @option args [Boolean] :verbose If `true`, the response includes output data for each processor in the executed pipeline.
-        # @option args [String] :id Pipeline to test. If you don't specify a `pipeline` in the request body, this parameter is required.
+        # @option args [Boolean] :verbose When `true`, the response includes output data for each processor in the pipeline
+        # @option args [String] :id The pipeline to test. If you don't specify a `pipeline` in the request body, this parameter is required.
         # @option args [Hash] :body *Required* The simulate definition
         def simulate(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/ltr/stats.rb

@@ -0,0 +1,41 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Ltr
+      module Actions
+        # Provides information about the current status of the LTR plugin.
+        #
+        # @option args [Enumerable<String>] :node_id Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
+        # @option args [String] :timeout The time in milliseconds to wait for a response.
+        # @option args [Enumerable<String>] :stat Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats.
+        def stats(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _node_id = args.delete('node_id')
+          _stat = args.delete('stat')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_ltr', _node_id, 'stats', _stat)
+
+          Utils.validate_query_params! args, STATS_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        STATS_QUERY_PARAMS = Set.new(%w[
+          timeout
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/sm/create_policy.rb

@@ -15,7 +15,7 @@ module OpenSearch
       module Actions
         # Creates a snapshot management policy.
         #
-        # @option args [String] :policy_name *Required* The name of the snapshot management policy.
+        # @option args [String] :policy_name *Required* The snapshot management policy name.
         # @option args [Hash] :body
         def create_policy(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/sm/delete_policy.rb

@@ -15,7 +15,7 @@ module OpenSearch
       module Actions
         # Deletes a snapshot management policy.
         #
-        # @option args [String] :policy_name *Required* The name of the snapshot management policy.
+        # @option args [String] :policy_name *Required* The snapshot management policy name.
         def delete_policy(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'policy_name' missing" if args['policy_name'].nil?

data/lib/opensearch/api/actions/sm/explain_policy.rb

@@ -15,7 +15,7 @@ module OpenSearch
       module Actions
         # Explains the state of the snapshot management policy.
         #
-        # @option args [String] :policy_name *Required* The name of the snapshot management policy.
+        # @option args [String] :policy_name *Required* The snapshot management policy name.
         def explain_policy(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'policy_name' missing" if args['policy_name'].nil?

data/lib/opensearch/api/actions/sm/get_policies.rb

@@ -15,11 +15,11 @@ module OpenSearch
       module Actions
         # Retrieves all snapshot management policies with optional pagination and filtering.
         #
-        # @option args [Integer] :from The starting index (default: 0)
-        # @option args [String] :queryString A query string to filter policies.
-        # @option args [Integer] :size The number of policies to return.
-        # @option args [String] :sortField The field to sort on.
-        # @option args [String] :sortOrder (default: asc) The order of sorting.
+        # @option args [Integer] :from (default: 0) The index to retrieve snapshot management policies from.
+        # @option args [String] :queryString Filters the returned snapshot management policies based on query string.
+        # @option args [Integer] :size The number of snapshot management policies to return.
+        # @option args [String] :sortField The name of the query field to sort on.
+        # @option args [String] :sortOrder (default: asc) The order to sort the snapshot management policy result.
         def get_policies(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}

data/lib/opensearch/api/actions/sm/get_policy.rb

@@ -15,7 +15,7 @@ module OpenSearch
       module Actions
         # Retrieves a specific snapshot management policy by name.
         #
-        # @option args [String] :policy_name *Required* The name of the snapshot management policy.
+        # @option args [String] :policy_name *Required* The snapshot management name.
         def get_policy(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'policy_name' missing" if args['policy_name'].nil?

data/lib/opensearch/api/actions/sm/start_policy.rb

@@ -15,7 +15,7 @@ module OpenSearch
       module Actions
         # Starts a snapshot management policy.
         #
-        # @option args [String] :policy_name *Required* The name of the snapshot management policy.
+        # @option args [String] :policy_name *Required* The snapshot management policy name.
         def start_policy(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'policy_name' missing" if args['policy_name'].nil?

data/lib/opensearch/api/actions/sm/stop_policy.rb

@@ -15,7 +15,7 @@ module OpenSearch
       module Actions
         # Stops a snapshot management policy.
         #
-        # @option args [String] :policy_name *Required* The name of the snapshot management policy.
+        # @option args [String] :policy_name *Required* The snapshot management policy name.
         def stop_policy(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'policy_name' missing" if args['policy_name'].nil?

data/lib/opensearch/api/actions/sm/update_policy.rb

@@ -15,7 +15,7 @@ module OpenSearch
       module Actions
         # Updates an existing snapshot management policy. Requires `if_seq_no` and `if_primary_term`.
         #
-        # @option args [String] :policy_name *Required* The name of the snapshot management policy.
+        # @option args [String] :policy_name *Required* The snapshot management policy name.
         # @option args [Integer] :if_primary_term *Required* The primary term of the policy to update.
         # @option args [Integer] :if_seq_no *Required* The sequence number of the policy to update.
         # @option args [Hash] :body

data/lib/opensearch/api/actions/snapshot/cleanup_repository.rb

@@ -13,12 +13,12 @@ module OpenSearch
   module API
     module Snapshot
       module Actions
-        # Removes stale data from repository.
+        # Removes any stale data from a snapshot repository.
         #
         # @option args [String] :repository *Required* Snapshot repository to clean up.
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
         # @option args [String] :master_timeout DEPRECATED Period to wait for a connection to the cluster-manager node.
-        # @option args [String] :timeout Period to wait for a response.
+        # @option args [String] :timeout The amount of time to wait for a response.
         def cleanup_repository(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'repository' missing" if args['repository'].nil?

data/lib/opensearch/api/actions/snapshot/clone.rb

@@ -13,14 +13,14 @@ module OpenSearch
   module API
     module Snapshot
       module Actions
-        # Clones indexes from one snapshot into another snapshot in the same repository.
+        # Creates a clone of all or part of a snapshot in the same repository as the original snapshot.
         #
-        # @option args [String] :repository *Required* A repository name
-        # @option args [String] :snapshot *Required* The name of the snapshot to clone from
-        # @option args [String] :target_snapshot *Required* The name of the cloned snapshot to create
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :repository *Required* The name of repository which will contain the snapshots clone.
+        # @option args [String] :snapshot *Required* The name of the original snapshot.
+        # @option args [String] :target_snapshot *Required* The name of the cloned snapshot.
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
         # @option args [String] :master_timeout DEPRECATED Explicit operation timeout for connection to cluster-manager node
-        # @option args [Hash] :body *Required* The snapshot clone definition
+        # @option args [Hash] :body *Required* The snapshot clone definition.
         def clone(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'repository' missing" if args['repository'].nil?

data/lib/opensearch/api/actions/snapshot/create.rb

@@ -13,14 +13,14 @@ module OpenSearch
   module API
     module Snapshot
       module Actions
-        # Creates a snapshot in a repository.
+        # Creates a snapshot within an existing repository.
         #
-        # @option args [String] :repository *Required* Repository for the snapshot.
-        # @option args [String] :snapshot *Required* Name of the snapshot. Must be unique in the repository.
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :repository *Required* The name of the repository where the snapshot will be stored.
+        # @option args [String] :snapshot *Required* The name of the snapshot. Must be unique in the repository.
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
         # @option args [String] :master_timeout DEPRECATED Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.
-        # @option args [Boolean] :wait_for_completion If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes.
-        # @option args [Hash] :body The snapshot definition
+        # @option args [Boolean] :wait_for_completion When `true`, the request returns a response when the snapshot is complete. When `false`, the request returns a response when the snapshot initializes.
+        # @option args [Hash] :body The snapshot definition.
         def create(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'repository' missing" if args['repository'].nil?

data/lib/opensearch/api/actions/snapshot/create_repository.rb

@@ -13,14 +13,14 @@ module OpenSearch
   module API
     module Snapshot
       module Actions
-        # Creates a repository.
+        # Creates a snapshot repository.
         #
-        # @option args [String] :repository *Required* A repository name
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :repository *Required* The name for the newly registered repository.
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
         # @option args [String] :master_timeout DEPRECATED Explicit operation timeout for connection to cluster-manager node
-        # @option args [String] :timeout Explicit operation timeout
-        # @option args [Boolean] :verify Whether to verify the repository after creation
-        # @option args [Hash] :body *Required* The repository definition
+        # @option args [String] :timeout The amount of time to wait for a response.
+        # @option args [Boolean] :verify When `true`, verifies the creation of the snapshot repository.
+        # @option args [Hash] :body *Required* The repository definition.
         def create_repository(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'repository' missing" if args['repository'].nil?

data/lib/opensearch/api/actions/snapshot/delete.rb

@@ -15,9 +15,9 @@ module OpenSearch
       module Actions
         # Deletes a snapshot.
         #
-        # @option args [String] :repository *Required* A repository name
-        # @option args [String] :snapshot *Required* A comma-separated list of snapshot names
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :repository *Required* The name of the snapshot repository to delete.
+        # @option args [String] :snapshot *Required* A comma-separated list of snapshot names to delete from the repository.
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
         # @option args [String] :master_timeout DEPRECATED Explicit operation timeout for connection to cluster-manager node
         def delete(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/snapshot/delete_repository.rb

@@ -13,12 +13,12 @@ module OpenSearch
   module API
     module Snapshot
       module Actions
-        # Deletes a repository.
+        # Deletes a snapshot repository.
         #
-        # @option args [Enumerable<String>, String] :repository *Required* Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported.
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [Enumerable<String>, String] :repository *Required* The name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported.
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
         # @option args [String] :master_timeout DEPRECATED Explicit operation timeout for connection to cluster-manager node
-        # @option args [String] :timeout Explicit operation timeout
+        # @option args [String] :timeout The amount of time to wait for a response.
         def delete_repository(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'repository' missing" if args['repository'].nil?

data/lib/opensearch/api/actions/snapshot/get.rb

@@ -15,12 +15,12 @@ module OpenSearch
       module Actions
         # Returns information about a snapshot.
         #
-        # @option args [String] :repository *Required* Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported.
-        # @option args [Enumerable<String>, String] :snapshot *Required* Comma-separated list of snapshot names to retrieve. Also accepts wildcards (`*`). - To get information about all snapshots in a registered repository, use a wildcard (`*`) or `_all`. - To get information about any snapshots that are currently running, use `_current`.
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
-        # @option args [Boolean] :ignore_unavailable If `false`, the request returns an error for any snapshots that are unavailable.
+        # @option args [String] :repository *Required* A comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported.
+        # @option args [Enumerable<String>, String] :snapshot *Required* A comma-separated list of snapshot names to retrieve. Also accepts wildcard expressions. (`*`). - To get information about all snapshots in a registered repository, use a wildcard (`*`) or `_all`. - To get information about any snapshots that are currently running, use `_current`.
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
+        # @option args [Boolean] :ignore_unavailable When `false`, the request returns an error for any snapshots that are unavailable.
         # @option args [String] :master_timeout DEPRECATED Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.
-        # @option args [Boolean] :verbose If `true`, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.
+        # @option args [Boolean] :verbose When `true`, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards contained in the snapshot.
         def get(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'repository' missing" if args['repository'].nil?

data/lib/opensearch/api/actions/snapshot/get_repository.rb

@@ -13,12 +13,12 @@ module OpenSearch
   module API
     module Snapshot
       module Actions
-        # Returns information about a repository.
+        # Returns information about a snapshot repository.
         #
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
-        # @option args [Boolean] :local Return local information, do not retrieve the state from cluster-manager node.
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
+        # @option args [Boolean] :local Whether to get information from the local node.
         # @option args [String] :master_timeout DEPRECATED Explicit operation timeout for connection to cluster-manager node
-        # @option args [Enumerable<String>, String] :repository A comma-separated list of repository names
+        # @option args [Enumerable<String>, String] :repository A comma-separated list of repository names.
         def get_repository(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           _repository = args.delete('repository')

data/lib/opensearch/api/actions/snapshot/restore.rb

@@ -15,12 +15,12 @@ module OpenSearch
       module Actions
         # Restores a snapshot.
         #
-        # @option args [String] :repository *Required* A repository name
-        # @option args [String] :snapshot *Required* A snapshot name
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :repository *Required* The name of the repository containing the snapshot
+        # @option args [String] :snapshot *Required* The name of the snapshot to restore.
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
         # @option args [String] :master_timeout DEPRECATED Explicit operation timeout for connection to cluster-manager node
-        # @option args [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
-        # @option args [Hash] :body Details of what to restore
+        # @option args [Boolean] :wait_for_completion -| Whether to return a response after the restore operation has completed. When `false`, the request returns a response when the restore operation initializes. When `true`, the request returns a response when the restore operation completes.
+        # @option args [Hash] :body Determines which settings and indexes to restore when restoring a snapshot
         def restore(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'repository' missing" if args['repository'].nil?

data/lib/opensearch/api/actions/snapshot/status.rb

@@ -15,11 +15,11 @@ module OpenSearch
       module Actions
         # Returns information about the status of a snapshot.
         #
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
-        # @option args [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to `false` which means a SnapshotMissingException is thrown
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
+        # @option args [Boolean] :ignore_unavailable Whether to ignore any unavailable snapshots, When `false`, a `SnapshotMissingException` is thrown.
         # @option args [String] :master_timeout DEPRECATED Explicit operation timeout for connection to cluster-manager node
-        # @option args [String] :repository A repository name
-        # @option args [Enumerable<String>, String] :snapshot A comma-separated list of snapshot names
+        # @option args [String] :repository The name of the repository containing the snapshot.
+        # @option args [Enumerable<String>, String] :snapshot A comma-separated list of snapshot names.
         def status(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           _repository = args.delete('repository')

data/lib/opensearch/api/actions/snapshot/verify_repository.rb

@@ -15,10 +15,10 @@ module OpenSearch
       module Actions
         # Verifies a repository.
         #
-        # @option args [String] :repository *Required* A repository name
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :repository *Required* The name of the repository containing the snapshot.
+        # @option args [String] :cluster_manager_timeout The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters](https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units).
         # @option args [String] :master_timeout DEPRECATED Explicit operation timeout for connection to cluster-manager node
-        # @option args [String] :timeout Explicit operation timeout
+        # @option args [String] :timeout The amount of time to wait for a response.
         def verify_repository(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'repository' missing" if args['repository'].nil?

data/lib/opensearch/api/actions/tasks/cancel.rb

@@ -15,11 +15,11 @@ module OpenSearch
       module Actions
         # Cancels a task, if it can be cancelled through an API.
         #
-        # @option args [Enumerable<String>, String] :actions Comma-separated list or wildcard expression of actions used to limit the request.
-        # @option args [Enumerable<String>] :nodes Comma-separated list of node IDs or names used to limit the request.
-        # @option args [String] :parent_task_id Parent task ID used to limit the tasks.
-        # @option args [Boolean] :wait_for_completion Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false
-        # @option args [String] :task_id ID of the task.
+        # @option args [Enumerable<String>, String] :actions A comma-separated list of actions that should be returned. Keep empty to return all.
+        # @option args [Enumerable<String>] :nodes A comma-separated list of node IDs or names used to limit the returned information. Use `_local` to return information from the node you're connecting to, specify the node name to get information from a specific node, or keep the parameter empty to get information from all nodes.
+        # @option args [String] :parent_task_id Returns tasks with a specified parent task ID (`node_id:task_number`). Keep empty or set to -1 to return all.
+        # @option args [Boolean] :wait_for_completion Waits for the matching task to complete. When `true`, the request is blocked until the task has completed.
+        # @option args [String] :task_id The task ID.
         def cancel(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           _task_id = args.delete('task_id')

data/lib/opensearch/api/actions/tasks/get.rb

@@ -15,9 +15,9 @@ module OpenSearch
       module Actions
         # Returns information about a task.
         #
-        # @option args [String] :task_id *Required* ID of the task.
-        # @option args [String] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
-        # @option args [Boolean] :wait_for_completion If `true`, the request blocks until the task has completed.
+        # @option args [String] :task_id *Required* The task ID.
+        # @option args [String] :timeout (default: 30s) The amount of time to wait for a response.
+        # @option args [Boolean] :wait_for_completion Waits for the matching task to complete. When `true`, the request is blocked until the task has completed.
         def get(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'task_id' missing" if args['task_id'].nil?

data/lib/opensearch/api/actions/tasks/list.rb

@@ -15,13 +15,13 @@ module OpenSearch
       module Actions
         # Returns a list of tasks.
         #
-        # @option args [Enumerable<String>, String] :actions Comma-separated list or wildcard expression of actions used to limit the request.
-        # @option args [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
-        # @option args [String] :group_by Key used to group tasks in the response.
-        # @option args [Enumerable<String>] :nodes Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
-        # @option args [String] :parent_task_id Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of `-1`.
-        # @option args [String] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
-        # @option args [Boolean] :wait_for_completion If `true`, the request blocks until the operation is complete.
+        # @option args [Enumerable<String>, String] :actions A comma-separated list of actions that should be returned. Keep empty to return all.
+        # @option args [Boolean] :detailed When `true`, the response includes detailed information about shard recoveries.
+        # @option args [String] :group_by (default: nodes) Groups tasks by parent/child relationships or nodes.
+        # @option args [Enumerable<String>] :nodes A comma-separated list of node IDs or names used to limit the returned information. Use `_local` to return information from the node you're connecting to, specify the node name to get information from a specific node, or keep the parameter empty to get information from all nodes.
+        # @option args [String] :parent_task_id Returns tasks with a specified parent task ID (`node_id:task_number`). Keep empty or set to -1 to return all.
+        # @option args [String] :timeout The amount of time to wait for a response.
+        # @option args [Boolean] :wait_for_completion Waits for the matching task to complete. When `true`, the request is blocked until the task has completed.
         def list(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}

data/lib/opensearch/transport/client.rb

@@ -105,6 +105,8 @@ module OpenSearch
       #
       # @option arguments [Integer] :request_timeout The request timeout to be passed to transport in options
       #
+      # @option arguments [Object] :request_signer An object that responds to `#sign_request` and returns a hash of headers
+      #
       # @option arguments [Symbol] :adapter A specific adapter for Faraday (e.g. `:patron`)
       #
       # @option arguments [Hash] :transport_options Options to be passed to the `Faraday::Connection` constructor
@@ -147,6 +149,7 @@ module OpenSearch
         @arguments[:http]               ||= {}
         @options[:http]                 ||= {}
         @options[:ignore_404_on_delete] ||= false
+        @options[:request_signer]       ||= nil
 
         set_api_key if (@api_key = @arguments[:api_key])
         set_compatibility_header if ENV['ELASTIC_CLIENT_APIVERSIONING']
@@ -183,13 +186,22 @@ module OpenSearch
       end
 
       # Performs a request through delegation to {#transport}.
-      def perform_request(method, path, params = {}, body = nil, headers = nil)
+      def perform_request(method, path, params = {}, body = nil, headers = {})
         method = @send_get_body_as if method == 'GET' && body
-        if (opaque_id = params.delete(:opaque_id))
-          headers = {} if headers.nil?
+        if (opaque_id = params.delete('opaque_id'))
           opaque_id = @opaque_id_prefix ? "#{@opaque_id_prefix}#{opaque_id}" : opaque_id
           headers.merge!('X-Opaque-Id' => opaque_id)
         end
+        if @options[:request_signer]
+          connection = transport.get_connection
+          headers = @options[:request_signer].sign_request(
+            method: method, path: path, params: params, body: body, headers: headers,
+            host: connection.host[:host],
+            port: connection.host[:port],
+            url: connection.full_url(path, params),
+            logger: @arguments[:logger]
+          )
+        end
         transport.perform_request(method, path, params, body, headers)
       end
 

data/lib/opensearch/version.rb

@@ -25,5 +25,5 @@
 # under the License.
 
 module OpenSearch
-  VERSION = '4.0.0-beta.2'.freeze
+  VERSION = '4.0.0-beta.3'.freeze
 end

data/lib/opensearch.rb

@@ -64,6 +64,10 @@ module OpenSearch
       @list ||= OpenSearch::API::Namespace.new(transport, OpenSearch::API::List::Actions)
     end
 
+    def ltr
+      @ltr ||= OpenSearch::API::Namespace.new(transport, OpenSearch::API::Ltr::Actions)
+    end
+
     def ml
       @ml ||= OpenSearch::API::Namespace.new(transport, OpenSearch::API::Ml::Actions)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opensearch-ruby
 version: !ruby/object:Gem::Version
-  version: 4.0.0.pre.beta.2
+  version: 4.0.0.pre.beta.3
 platform: ruby
 authors:
 - Elastic
@@ -31,7 +31,7 @@ cert_chain:
   m0rB25J1sO2yjlalRdBoV5p7OKaWG4CGMr+q6vCC2za7yrtZiYOOv+KpWmheTwds
   P1nbdIL2eAXGfNU3cbtYisS1sSYi7VSkS52pVk8Jgtw=
   -----END CERTIFICATE-----
-date: 2025-03-06 00:00:00.000000000 Z
+date: 2025-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -263,6 +263,7 @@ files:
 - lib/opensearch/api/actions/list/help.rb
 - lib/opensearch/api/actions/list/indices.rb
 - lib/opensearch/api/actions/list/shards.rb
+- lib/opensearch/api/actions/ltr/stats.rb
 - lib/opensearch/api/actions/mget.rb
 - lib/opensearch/api/actions/ml/chunk_model.rb
 - lib/opensearch/api/actions/ml/create_connector.rb