Updated opensearch-ruby to reflect the latest OpenSearch API spec (2025-02-23)

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: dblock

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

@@ -18,7 +18,7 @@ module Actions
         # @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)
+        # @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.

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

@@ -15,7 +15,7 @@ module Cluster
       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] :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.

lib/opensearch/api/actions/delete_by_query_rethrottle.rb

@@ -15,7 +15,7 @@ module Root
       module Actions
         # Changes the number of requests per second for a particular Delete By Query operation.
         #
-        # @option args [Float, String] :task_id *Required* The ID for the task.
+        # @option args [String] :task_id *Required* The ID for the task.
         # @option args [Float] :requests_per_second The throttle for this request in sub-requests per second.
         def delete_by_query_rethrottle(args = {})
           args = Utils.clone_and_normalize_arguments(args)

lib/opensearch/api/actions/security/authinfo.rb

@@ -13,10 +13,10 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Returns the authentication information.
+        # Returns or updates authentication information for the currently authenticated user.
         #
-        # @option args [String] :auth_type The type of current authentication request.
-        # @option args [Boolean] :verbose Indicates whether a verbose response should be returned.
+        # @option args [String] :auth_type The type of the current authentication request.
+        # @option args [Boolean] :verbose Whether to return a verbose response.
         def authinfo(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}

lib/opensearch/api/actions/security/authtoken.rb

@@ -13,7 +13,7 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Returns the authorization token.
+        # Returns the authorization token for the current user.
         #
         def authtoken(args = {})
           args = Utils.clone_and_normalize_arguments(args)

lib/opensearch/api/actions/security/config_upgrade_check.rb

@@ -13,7 +13,7 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Check whether or not an upgrade can be performed and what resources can be updated.
+        # Checks whether or not an upgrade can be performed and which security resources can be updated.
         #
         def config_upgrade_check(args = {})
           args = Utils.clone_and_normalize_arguments(args)

lib/opensearch/api/actions/security/config_upgrade_perform.rb

@@ -13,7 +13,7 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Helps cluster operator upgrade missing defaults and stale default definitions.
+        # Assists the cluster operator with upgrading missing default values and stale default definitions.
         #
         # @option args [Hash] :body
         def config_upgrade_perform(args = {})

lib/opensearch/api/actions/security/create_allowlist.rb

@@ -13,7 +13,7 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Creates or replaces the permitted APIs. Accessible using Super Admin certificate or REST API permission.
+        # Creates or replaces APIs permitted for users on the allow list. Requires a super admin certificate or REST API permissions.
         #
         # @option args [Hash] :body *Required*
         def create_allowlist(args = {})

lib/opensearch/api/actions/security/create_role.rb

@@ -15,7 +15,7 @@ module Security
       module Actions
         # Creates or replaces the specified role.
         #
-        # @option args [String] :role *Required* The name of the role to be created.
+        # @option args [String] :role *Required* The name of the role to create.
         # @option args [Hash] :body *Required*
         def create_role(args = {})
           args = Utils.clone_and_normalize_arguments(args)

lib/opensearch/api/actions/security/create_role_mapping.rb

@@ -15,7 +15,7 @@ module Security
       module Actions
         # Creates or replaces the specified role mapping.
         #
-        # @option args [String] :role *Required* The name of the role to create a role mapping for.
+        # @option args [String] :role *Required* The name of the role for which to create a role mapping.
         # @option args [Hash] :body *Required*
         def create_role_mapping(args = {})
           args = Utils.clone_and_normalize_arguments(args)