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

data/lib/opensearch/api/actions/cat/segments.rb

@@ -15,14 +15,14 @@ module OpenSearch
       module Actions
         # Provides low-level information about the segments in the shards of an index.
         #
-        # @option args [String] :bytes The unit used to display byte values.
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
-        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
-        # @option args [Enumerable<String>] :h Comma-separated list of column names to display.
-        # @option args [Boolean] :help Return help information.
-        # @option args [String] :master_timeout DEPRECATED Operation timeout for connection to cluster-manager node.
-        # @option args [Enumerable<String>] :s Comma-separated list of column names or column aliases to sort by.
-        # @option args [Boolean] :v Verbose mode. Display column headers.
+        # @option args [String] :bytes The units used to display byte values.
+        # @option args [String] :cluster_manager_timeout The amount of time allowed to establish a connection to the cluster manager node.
+        # @option args [String] :format A short version of the `Accept` header, such as `json` or `yaml`.
+        # @option args [Enumerable<String>] :h A comma-separated list of column names to display.
+        # @option args [Boolean] :help Returns help information.
+        # @option args [String] :master_timeout DEPRECATED The amount of time allowed to establish a connection to the cluster manager node.
+        # @option args [Enumerable<String>] :s A comma-separated list of column names or column aliases to sort by.
+        # @option args [Boolean] :v Enables verbose mode, which displays column headers.
         # @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 segments(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/cat/shards.rb

@@ -13,18 +13,18 @@ module OpenSearch
   module API
     module Cat
       module Actions
-        # Provides a detailed view of shard allocation on nodes.
+        # Lists the states of all primary and replica shards and how they are distributed.
         #
-        # @option args [String] :bytes The unit used to display byte values.
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
-        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
-        # @option args [Enumerable<String>] :h Comma-separated list of column names to display.
-        # @option args [Boolean] :help Return help information.
-        # @option args [Boolean] :local Return local information, do not retrieve the state from cluster-manager node.
-        # @option args [String] :master_timeout DEPRECATED Operation timeout for connection to cluster-manager node.
-        # @option args [Enumerable<String>] :s Comma-separated list of column names or column aliases to sort by.
-        # @option args [String] :time The unit in which to display time values.
-        # @option args [Boolean] :v Verbose mode. Display column headers.
+        # @option args [String] :bytes The units used to display byte values.
+        # @option args [String] :cluster_manager_timeout The amount of time allowed to establish a connection to the cluster manager node.
+        # @option args [String] :format A short version of the `Accept` header, such as `json` or `yaml`.
+        # @option args [Enumerable<String>] :h A comma-separated list of column names to display.
+        # @option args [Boolean] :help Returns help information.
+        # @option args [Boolean] :local Returns local information but does not retrieve the state from the cluster manager node.
+        # @option args [String] :master_timeout DEPRECATED The amount of time allowed to establish a connection to the cluster manager node.
+        # @option args [Enumerable<String>] :s A comma-separated list of column names or column aliases to sort by.
+        # @option args [String] :time Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/).
+        # @option args [Boolean] :v Enables verbose mode, which displays column headers.
         # @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 shards(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/cat/snapshots.rb

@@ -13,18 +13,18 @@ module OpenSearch
   module API
     module Cat
       module Actions
-        # Returns all snapshots in a specific repository.
+        # Lists all of the snapshots stored in a specific repository.
         #
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
-        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
-        # @option args [Enumerable<String>] :h Comma-separated list of column names to display.
-        # @option args [Boolean] :help Return help information.
-        # @option args [Boolean] :ignore_unavailable If `true`, the response does not include information from unavailable snapshots.
-        # @option args [String] :master_timeout DEPRECATED 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] :format A short version of the `Accept` header, such as `json` or `yaml`.
+        # @option args [Enumerable<String>] :h A comma-separated list of column names to display.
+        # @option args [Boolean] :help Returns help information.
+        # @option args [Boolean] :ignore_unavailable When `true`, the response does not include information from unavailable snapshots.
+        # @option args [String] :master_timeout DEPRECATED The amount of time allowed to establish a connection to the cluster manager node.
         # @option args [Enumerable<String>, String] :repository *Required* A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. If any repository fails during the request, OpenSearch returns an error.
-        # @option args [Enumerable<String>] :s Comma-separated list of column names or column aliases to sort by.
-        # @option args [String] :time The unit in which to display time values.
-        # @option args [Boolean] :v Verbose mode. Display column headers.
+        # @option args [Enumerable<String>] :s A comma-separated list of column names or column aliases to sort by.
+        # @option args [String] :time Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/).
+        # @option args [Boolean] :v Enables verbose mode, which displays column headers.
         def snapshots(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'repository' missing" if args['repository'].nil?

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

@@ -13,18 +13,18 @@ module OpenSearch
   module API
     module Cat
       module Actions
-        # Returns information about the tasks currently executing on one or more nodes in the cluster.
+        # Lists the progress of all tasks currently running on the cluster.
         #
-        # @option args [Enumerable<String>] :actions The task action names, which are used to limit the response.
+        # @option args [Enumerable<String>] :actions The task action names used to limit the response.
         # @option args [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
-        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
-        # @option args [Enumerable<String>] :h Comma-separated list of column names to display.
-        # @option args [Boolean] :help Return help information.
-        # @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] :format A short version of the `Accept` header, such as `json` or `yaml`.
+        # @option args [Enumerable<String>] :h A comma-separated list of column names to display.
+        # @option args [Boolean] :help Returns help information.
+        # @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 to which you're connecting, specify a specific node from which to get information, or keep the parameter empty to get information from all nodes.
         # @option args [String] :parent_task_id The parent task identifier, which is used to limit the response.
-        # @option args [Enumerable<String>] :s Comma-separated list of column names or column aliases to sort by.
-        # @option args [String] :time The unit in which to display time values.
-        # @option args [Boolean] :v Verbose mode. Display column headers.
+        # @option args [Enumerable<String>] :s A comma-separated list of column names or column aliases to sort by.
+        # @option args [String] :time Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/).
+        # @option args [Boolean] :v Enables verbose mode, which displays column headers.
         def tasks(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}

data/lib/opensearch/api/actions/cat/templates.rb

@@ -13,16 +13,16 @@ module OpenSearch
   module API
     module Cat
       module Actions
-        # Returns information about existing templates.
+        # Lists the names, patterns, order numbers, and version numbers of index templates.
         #
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
-        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
-        # @option args [Enumerable<String>] :h Comma-separated list of column names to display.
-        # @option args [Boolean] :help Return help information.
-        # @option args [Boolean] :local Return local information, do not retrieve the state from cluster-manager node.
-        # @option args [String] :master_timeout DEPRECATED Operation timeout for connection to cluster-manager node.
-        # @option args [Enumerable<String>] :s Comma-separated list of column names or column aliases to sort by.
-        # @option args [Boolean] :v Verbose mode. Display column headers.
+        # @option args [String] :cluster_manager_timeout The amount of time allowed to establish a connection to the cluster manager node.
+        # @option args [String] :format A short version of the `Accept` header, such as `json` or `yaml`.
+        # @option args [Enumerable<String>] :h A comma-separated list of column names to display.
+        # @option args [Boolean] :help Returns help information.
+        # @option args [Boolean] :local Returns local information but does not retrieve the state from the cluster manager node.
+        # @option args [String] :master_timeout DEPRECATED The amount of time allowed to establish a connection to the cluster manager node.
+        # @option args [Enumerable<String>] :s A comma-separated list of column names or column aliases to sort by.
+        # @option args [Boolean] :v Enables verbose mode, which displays column headers.
         # @option args [String] :name The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.
         def templates(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/cat/thread_pool.rb

@@ -14,17 +14,17 @@ module OpenSearch
     module Cat
       module Actions
         # Returns cluster-wide thread pool statistics per node.
-        # By default the active, queue and rejected statistics are returned for all thread pools.
+        # By default the active, queued, and rejected statistics are returned for all thread pools.
         #
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
-        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
-        # @option args [Enumerable<String>] :h Comma-separated list of column names to display.
-        # @option args [Boolean] :help Return help information.
-        # @option args [Boolean] :local Return local information, do not retrieve the state from cluster-manager node.
-        # @option args [String] :master_timeout DEPRECATED Operation timeout for connection to cluster-manager node.
-        # @option args [Enumerable<String>] :s Comma-separated list of column names or column aliases to sort by.
+        # @option args [String] :cluster_manager_timeout A timeout for connection to the cluster manager node.
+        # @option args [String] :format A short version of the `Accept` header, such as `json` or `yaml`.
+        # @option args [Enumerable<String>] :h A comma-separated list of column names to display.
+        # @option args [Boolean] :help Returns help information.
+        # @option args [Boolean] :local Returns local information but does not retrieve the state from the cluster manager node.
+        # @option args [String] :master_timeout DEPRECATED The amount of time allowed to establish a connection to the cluster manager node.
+        # @option args [Enumerable<String>] :s A comma-separated list of column names or column aliases to sort by.
         # @option args [Integer] :size The multiplier in which to display values.
-        # @option args [Boolean] :v Verbose mode. Display column headers.
+        # @option args [Boolean] :v Enables verbose mode, which displays column headers.
         # @option args [Enumerable<String>, String] :thread_pool_patterns A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.
         def thread_pool(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/clear_scroll.rb

@@ -17,19 +17,17 @@ module OpenSearch
         #
         # @option args [Enumerable<String>, String] :scroll_id DEPRECATED Comma-separated list of scroll IDs to clear. To clear all scroll IDs, use `_all`.
         # @option args [Hash] :body Comma-separated list of scroll IDs to clear if none was specified using the `scroll_id` parameter
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
         def clear_scroll(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           _scroll_id = args.delete('scroll_id')
 
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = Utils.build_url('_search/scroll', _scroll_id)
 
           Utils.validate_query_params! args
-          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
+          transport.perform_delete_request method, url, args, body, headers
         end
       end
     end

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

@@ -13,11 +13,11 @@ module OpenSearch
   module API
     module Cluster
       module Actions
-        # Provides explanations for shard allocations in the cluster.
+        # 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 If `true`, returns information about disk usage and shard sizes.
-        # @option args [Boolean] :include_yes_decisions If `true`, returns YES decisions in explanation.
-        # @option args [Hash] :body The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'
+        # @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 [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)
           headers = args.delete('headers') || {}

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

@@ -15,25 +15,23 @@ module OpenSearch
       module Actions
         # Deletes a component template.
         #
-        # @option args [String] :name *Required* Name of the component template to delete. Wildcard (*) expressions are supported.
+        # @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] :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 [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
+        # @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?
 
           _name = args.delete('name')
 
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = Utils.build_url('_component_template', _name)
 
           Utils.validate_query_params! args, DELETE_COMPONENT_TEMPLATE_QUERY_PARAMS
-          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
+          transport.perform_delete_request method, url, args, body, headers
         end
 
         DELETE_COMPONENT_TEMPLATE_QUERY_PARAMS = Set.new(%w[

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

@@ -13,19 +13,17 @@ module OpenSearch
   module API
     module Cluster
       module Actions
-        # Delete any existing decommission.
+        # Recommissions a decommissioned zone.
         #
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
         def delete_decommission_awareness(args = {})
           args = Utils.clone_and_normalize_arguments(args)
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = '_cluster/decommission/awareness'
 
           Utils.validate_query_params! args
-          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
+          transport.perform_delete_request method, url, args, body, headers
         end
       end
     end

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

@@ -13,20 +13,18 @@ module OpenSearch
   module API
     module Cluster
       module Actions
-        # Clears cluster voting config exclusions.
+        # Clears any cluster voting configuration exclusions.
         #
-        # @option args [Boolean] :wait_for_removal (default: true) Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. Defaults to true, meaning that all excluded nodes must be removed from the cluster before this API takes any action. If set to `false` then the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster.
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
+        # @option args [Boolean] :wait_for_removal (default: true) Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. When `true`, all excluded nodes are removed from the cluster before this API takes any action. When `false`, the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster.
         def delete_voting_config_exclusions(args = {})
           args = Utils.clone_and_normalize_arguments(args)
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = '_cluster/voting_config_exclusions'
 
           Utils.validate_query_params! args, DELETE_VOTING_CONFIG_EXCLUSIONS_QUERY_PARAMS
-          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
+          transport.perform_delete_request method, url, args, body, headers
         end
 
         DELETE_VOTING_CONFIG_EXCLUSIONS_QUERY_PARAMS = Set.new(%w[

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

@@ -16,17 +16,15 @@ module OpenSearch
         # Delete weighted shard routing weights.
         #
         # @option args [Hash] :body
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
         def delete_weighted_routing(args = {})
           args = Utils.clone_and_normalize_arguments(args)
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = '_cluster/routing/awareness/weights'
 
           Utils.validate_query_params! args
-          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
+          transport.perform_delete_request method, url, args, body, headers
         end
       end
     end

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

@@ -15,10 +15,10 @@ module OpenSearch
       module Actions
         # Returns information about whether a particular component template exist.
         #
-        # @option args [String] :name *Required* Name of the component template to check existence of. Wildcard (*) expressions are supported.
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
-        # @option args [Boolean] :local If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from 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] :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 [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 = {})
           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

@@ -15,10 +15,11 @@ module OpenSearch
       module Actions
         # Returns one or more component templates.
         #
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
-        # @option args [Boolean] :local If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from 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] :name Name of the component template to retrieve. 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 [Boolean] :flat_settings If `true`, returns settings in flat format.
+        # @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.
         def get_component_template(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           _name = args.delete('name')
@@ -34,6 +35,7 @@ module OpenSearch
 
         GET_COMPONENT_TEMPLATE_QUERY_PARAMS = Set.new(%w[
           cluster_manager_timeout
+          flat_settings
           local
           master_timeout
         ]).freeze

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

@@ -13,9 +13,9 @@ module OpenSearch
   module API
     module Cluster
       module Actions
-        # Get details and status of decommissioned attribute.
+        # Retrieves the decommission status for all zones.
         #
-        # @option args [String] :awareness_attribute_name *Required* Awareness attribute name.
+        # @option args [String] :awareness_attribute_name *Required* The name of the awareness attribute.
         def get_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/get_settings.rb

@@ -15,11 +15,11 @@ module OpenSearch
       module Actions
         # Returns cluster settings.
         #
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
-        # @option args [Boolean] :flat_settings If `true`, returns settings in flat format.
-        # @option args [Boolean] :include_defaults If `true`, returns default cluster settings from the local 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] :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 [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.
         def get_settings(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}

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

@@ -15,7 +15,7 @@ module OpenSearch
       module Actions
         # Fetches weighted shard routing weights.
         #
-        # @option args [String] :attribute *Required* Awareness attribute name.
+        # @option args [String] :attribute *Required* The name of the awareness attribute.
         def get_weighted_routing(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'attribute' missing" if args['attribute'].nil?

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

@@ -15,20 +15,20 @@ module OpenSearch
       module Actions
         # Returns basic information about the health of the cluster.
         #
-        # @option args [String] :awareness_attribute The awareness attribute for which the health is required.
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
-        # @option args [Enumerable<String>, String] :expand_wildcards Whether to expand wildcard expression to concrete indexes that are open, closed or both.
-        # @option args [String] :level Can be one of cluster, indexes or shards. Controls the details level of the health information returned.
-        # @option args [Boolean] :local If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from 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 [Integer, String] :wait_for_active_shards A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait.
-        # @option args [String] :wait_for_events Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed.
-        # @option args [Boolean] :wait_for_no_initializing_shards A Boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards.
-        # @option args [Boolean] :wait_for_no_relocating_shards A Boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards.
-        # @option args [Float, String] :wait_for_nodes The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation.
-        # @option args [String] :wait_for_status One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status.
-        # @option args [Enumerable<String>, String] :index Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`.
+        # @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] :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] :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.
+        # @option args [Float, String] :wait_for_nodes Waits until the specified number of nodes (`N`) is available. Accepts `>=N`, `<=N`, `>N`, and `<N`. You can also use `ge(N)`, `le(N)`, `gt(N)`, and `lt(N)` notation.
+        # @option args [String] :wait_for_status Waits until the cluster health reaches the specified status or better.
+        # @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 health(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           _index = args.delete('index')

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

@@ -13,12 +13,12 @@ module OpenSearch
   module API
     module Cluster
       module Actions
-        # Returns a list of any cluster-level changes (e.g. create index, update mapping,
-        # allocate or fail shard) which have not yet been executed.
+        # Returns a list of pending cluster-level tasks, such as index creation, mapping updates,
+        # or new allocations.
         #
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
-        # @option args [Boolean] :local If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from 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] :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] :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 = {})
           args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}

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

@@ -13,11 +13,11 @@ module OpenSearch
   module API
     module Cluster
       module Actions
-        # Updates the cluster voting config exclusions by node ids or node names.
+        # Updates the cluster voting configuration by excluding certain node IDs or names.
         #
-        # @option args [Enumerable<String>, String] :node_ids A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify `node_names`.
-        # @option args [Enumerable<String>, String] :node_names A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify `node_ids`.
-        # @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. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error.
+        # @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 [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)
           headers = args.delete('headers') || {}

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

@@ -15,12 +15,12 @@ module OpenSearch
       module Actions
         # Creates or updates a component template.
         #
-        # @option args [String] :name *Required* 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 Agent uses these templates to configure backing indexes for its data streams. If you use OpenSearch Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. If you don't use OpenSearch Agent and 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 Operation timeout for connection to cluster-manager node.
-        # @option args [Boolean] :create If `true`, this request cannot replace or update existing component templates.
-        # @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 Operation timeout.
-        # @option args [Hash] :body *Required* The template definition
+        # @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 [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 [Hash] :body *Required* The template definition.
         def put_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/put_decommission_awareness.rb

@@ -13,10 +13,10 @@ module OpenSearch
   module API
     module Cluster
       module Actions
-        # Decommissions an awareness attribute.
+        # 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* Awareness attribute name.
-        # @option args [String] :awareness_attribute_value *Required* Awareness attribute value.
+        # @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.
         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,11 +15,11 @@ module OpenSearch
       module Actions
         # Updates the cluster settings.
         #
-        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
-        # @option args [Boolean] :flat_settings Return settings in flat format.
-        # @option args [String] :master_timeout DEPRECATED Explicit operation timeout for connection to cluster-manager node
-        # @option args [String] :timeout Explicit operation timeout
-        # @option args [Hash] :body *Required* The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart).
+        # @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] :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)
           raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?

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* Awareness attribute name.
+        # @option args [String] :attribute *Required* The name of the awareness attribute.
         # @option args [Hash] :body
         def put_weighted_routing(args = {})
           args = Utils.clone_and_normalize_arguments(args)