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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52165e3bcc6883923f6bbfc57aeaf73b0cd9d054983804de6432baece83483ee
-  data.tar.gz: 0eb577153a23b0d91f091e901e8a209b6a880da271a5e426a27586bdccaa2710
+  metadata.gz: 042f372ee8559ded88873a96cba1bb5f635867e12f51e79dfc15d226df27249b
+  data.tar.gz: 04fe73ce9dc643661f0834776736ec0a50cb816b4c25fa350a4d7e5947513301
 SHA512:
-  metadata.gz: 900fd3c53f3b222fece0968e1094a87f5ce2cd6a7174d8a54470d74a19af5db6982351459d5efdedd03545ac824123daefb2373ae109a263fca50bbd755ba357
-  data.tar.gz: c72d67452b64da318baf2d9f71b2aff32ebb7c0e6f1eb493b5c91ddd7ab3b54590108b56dcc2ce5a705868cbf2c7772742029d55a85629de7a42cea129ce52e2
+  metadata.gz: d03ac4de4e5cace0d3896a9441e6a0d86f5da3b56cf87e9e101e1a9de472ce6c0e23d2e9ae63a4227eb975d349a410ac14c091c98a8fc2da2e17e303a6c08778
+  data.tar.gz: 5a98a0b9bab00c0783485cd7885de1a7abc79e8ef8bb3e6daf22c927d2761cf96ce37346a5576f96a750c720f6e392a34a5cf72c13f3e8c6f478051458c18b91

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

@@ -17,8 +17,8 @@ module OpenSearch
         #
         # @option args [String] :name *Required* The name of the component template to delete. Supports wildcard (*) expressions.
         # @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.
+        # @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 = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'name' missing" if args['name'].nil?

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

@@ -18,7 +18,7 @@ module OpenSearch
         # @option args [String] :name *Required* The name of the component template. Wildcard (*) expressions 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 [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] :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 = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'name' missing" if args['name'].nil?

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

@@ -18,7 +18,7 @@ module OpenSearch
         # @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] :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.
         def get_component_template(args = {})
           args = Utils.clone_and_normalize_arguments(args)

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

@@ -18,8 +18,8 @@ module OpenSearch
         # @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.
+        # @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 get_settings(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}

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

@@ -20,7 +20,7 @@ module OpenSearch
         # @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] :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 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.

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

@@ -18,7 +18,7 @@ module OpenSearch
         #
         # @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.
+        # @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 = {})
           args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}

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

@@ -18,8 +18,8 @@ module OpenSearch
         # @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.
+        # @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 template definition.
         def put_component_template(args = {})
           args = Utils.clone_and_normalize_arguments(args)

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

@@ -17,8 +17,8 @@ module OpenSearch
         #
         # @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 [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.
         def put_settings(args = {})
           args = Utils.clone_and_normalize_arguments(args)

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

@@ -18,10 +18,10 @@ module OpenSearch
         # @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 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 [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.
-        # @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 [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 The definition of `commands` to perform (`move`, `cancel`, `allocate`)
         def reroute(args = {})
           args = Utils.clone_and_normalize_arguments(args)

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

@@ -21,7 +21,7 @@ module OpenSearch
         # @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 [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 metric groups](https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/#metric-groups).

data/lib/opensearch/api/actions/replication/autofollow_stats.rb

@@ -13,7 +13,7 @@ module OpenSearch
   module API
     module Replication
       module Actions
-        # Gets information about auto-follow activity and any replication rules configured on the specified cluster.
+        # Retrieves information about any auto-follow activity and any replication rules configured on the specified cluster.
         #
         def autofollow_stats(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/replication/create_replication_rule.rb

@@ -13,7 +13,7 @@ module OpenSearch
   module API
     module Replication
       module Actions
-        # Automatically starts replication on indexes matching a specified pattern.
+        # Automatically starts the replication on indexes matching a specified pattern.
         #
         # @option args [Hash] :body *Required*
         def create_replication_rule(args = {})

data/lib/opensearch/api/actions/replication/follower_stats.rb

@@ -13,7 +13,7 @@ module OpenSearch
   module API
     module Replication
       module Actions
-        # Gets information about follower (syncing) indexes on a specified cluster.
+        # Retrieves information about any follower (syncing) indexes on a specified cluster.
         #
         def follower_stats(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/replication/leader_stats.rb

@@ -13,7 +13,7 @@ module OpenSearch
   module API
     module Replication
       module Actions
-        # Gets information about replicated leader indexes on a specified cluster.
+        # Retrieves information about any replicated leader indexes on a specified cluster.
         #
         def leader_stats(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/replication/pause.rb

@@ -13,9 +13,9 @@ module OpenSearch
   module API
     module Replication
       module Actions
-        # Pauses replication of the leader index.
+        # Pauses the replication of the leader index.
         #
-        # @option args [String] :index *Required* Name of the data stream, index, or index alias to perform bulk actions on.
+        # @option args [String] :index *Required* The name of the data stream, index, or index alias to perform bulk actions on.
         # @option args [Hash] :body *Required*
         def pause(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/replication/resume.rb

@@ -15,7 +15,7 @@ module OpenSearch
       module Actions
         # Resumes replication of the leader index.
         #
-        # @option args [String] :index *Required* Name of the data stream, index, or index alias to perform bulk actions on.
+        # @option args [String] :index *Required* The name of the data stream, index, or index alias to perform bulk actions on.
         # @option args [Hash] :body *Required*
         def resume(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/replication/start.rb

@@ -13,9 +13,9 @@ module OpenSearch
   module API
     module Replication
       module Actions
-        # Initiate replication of an index from the leader cluster to the follower cluster.
+        # Initiates the replication of an index from the leader cluster to the follower cluster.
         #
-        # @option args [String] :index *Required* Name of the data stream, index, or index alias to perform bulk actions on.
+        # @option args [String] :index *Required* The name of the data stream, index, or index alias to perform bulk actions on.
         # @option args [Hash] :body *Required*
         def start(args = {})
           args = Utils.clone_and_normalize_arguments(args)

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

@@ -13,9 +13,9 @@ module OpenSearch
   module API
     module Replication
       module Actions
-        # Gets the status of index replication.
+        # Retrieves the the status of an index replication.
         #
-        # @option args [String] :index *Required* Name of the data stream, index, or index alias to perform bulk actions on.
+        # @option args [String] :index *Required* The name of the data stream, index, or index alias to perform bulk actions on.
         def status(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'index' missing" if args['index'].nil?

data/lib/opensearch/api/actions/replication/stop.rb

@@ -13,9 +13,9 @@ module OpenSearch
   module API
     module Replication
       module Actions
-        # Terminates replication and converts the follower index to a standard index.
+        # Terminates the replication and converts the follower index to a standard index.
         #
-        # @option args [String] :index *Required* Name of the data stream, index, or index alias to perform bulk actions on.
+        # @option args [String] :index *Required* The name of the data stream, index, or index alias to perform bulk actions on.
         # @option args [Hash] :body *Required*
         def stop(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/replication/update_settings.rb

@@ -13,9 +13,9 @@ module OpenSearch
   module API
     module Replication
       module Actions
-        # Updates settings on the follower index.
+        # Updates any settings on the follower index.
         #
-        # @option args [String] :index *Required* Name of the data stream, index, or index alias to perform bulk actions on.
+        # @option args [String] :index *Required* The name of the data stream, index, or index alias to perform bulk actions on.
         # @option args [Hash] :body *Required*
         def update_settings(args = {})
           args = Utils.clone_and_normalize_arguments(args)

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 snapshot management policy name.
+        # @option args [String] :policy_name *Required* The name of the snapshot management policy to create.
         # @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 snapshot management policy name.
+        # @option args [String] :policy_name *Required* The name of the snapshot management policy to delete.
         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 snapshot management policy name.
+        # @option args [String] :policy_name *Required* The name of the snapshot management policy to explain.
         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 (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] :from (default: 0) The starting index from which to retrieve snapshot management policies.
+        # @option args [String] :queryString The query string to filter the returned snapshot management policies.
         # @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.
+        # @option args [String] :sortField The name of the field to sort the snapshot management policies by.
+        # @option args [String] :sortOrder (default: asc) The order to sort the snapshot management policies.
         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 snapshot management name.
+        # @option args [String] :policy_name *Required* The name of the snapshot management policy to retrieve.
         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 snapshot management policy name.
+        # @option args [String] :policy_name *Required* The name of the snapshot management policy to start.
         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 snapshot management policy name.
+        # @option args [String] :policy_name *Required* The name of the snapshot management policy to stop.
         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 snapshot management policy name.
+        # @option args [String] :policy_name *Required* The name of the snapshot management policy to update.
         # @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/transport/client.rb

@@ -188,10 +188,6 @@ module OpenSearch
       # Performs a request through delegation to {#transport}.
       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'))
-          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(

data/lib/opensearch/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opensearch-ruby
 version: !ruby/object:Gem::Version
-  version: 4.0.0.pre.beta.3
+  version: 4.0.0.pre.beta.4
 platform: ruby
 authors:
 - Elastic
@@ -31,7 +31,7 @@ cert_chain:
   m0rB25J1sO2yjlalRdBoV5p7OKaWG4CGMr+q6vCC2za7yrtZiYOOv+KpWmheTwds
   P1nbdIL2eAXGfNU3cbtYisS1sSYi7VSkS52pVk8Jgtw=
   -----END CERTIFICATE-----
-date: 2025-03-24 00:00:00.000000000 Z
+date: 2025-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday