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

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

@@ -20,8 +20,9 @@ module OpenSearch
         # @option args [Integer] :max_docs Maximum number of documents to process. By default, all documents.
         # @option args [Boolean, String] :refresh If `true`, the request refreshes affected shards to make this operation visible to search.
         # @option args [Float] :requests_per_second (default: 0) The throttle for this request in sub-requests per second. Defaults to no throttle.
+        # @option args [Boolean] :require_alias
         # @option args [String] :scroll Specifies how long a consistent view of the index should be maintained for scrolled search.
-        # @option args [Float, String] :slices The number of slices this task should be divided into. Defaults to 1 slice, meaning the task isn't sliced into subtasks.
+        # @option args [Integer, String] :slices The number of slices this task should be divided into. Defaults to 1 slice, meaning the task isn't sliced into subtasks.
         # @option args [String] :timeout Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.
         # @option args [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).
         # @option args [Boolean] :wait_for_completion (default: true) If `true`, the request blocks until the operation is complete.
@@ -43,6 +44,7 @@ module OpenSearch
           max_docs
           refresh
           requests_per_second
+          require_alias
           scroll
           slices
           timeout

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

@@ -13,7 +13,7 @@ module OpenSearch
   module API
     module Root
       module Actions
-        # Changes the number of requests per second for a particular Reindex operation.
+        # Changes the number of requests per second for a particular reindex operation.
         #
         # @option args [String] :task_id *Required* Identifier for the task.
         # @option args [Float] :requests_per_second The throttle for this request in sub-requests per second.

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

@@ -16,19 +16,17 @@ module OpenSearch
         # Deletes the specified replication rule.
         #
         # @option args [Hash] :body *Required*
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
         def delete_replication_rule(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
 
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = '_plugins/_replication/_autofollow'
 
           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/rollups/delete.rb

@@ -16,21 +16,19 @@ module OpenSearch
         # Delete index rollup.
         #
         # @option args [String] :id *Required* Rollup to access
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
         def delete(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
 
           _id = args.delete('id')
 
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = Utils.build_url('_plugins/_rollup/jobs', _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/scroll.rb

@@ -18,7 +18,7 @@ module OpenSearch
         # @option args [Boolean] :rest_total_hits_as_int If `true`, the API response's `hit.total` property is returned as an integer. If `false`, the API response's `hit.total` property is returned as an object.
         # @option args [String] :scroll Period to retain the search context for scrolling.
         # @option args [String] :scroll_id DEPRECATED The scroll ID for scrolled search
-        # @option args [Hash] :body The scroll ID if not passed by URL or query parameter.
+        # @option args [Hash] :body
         def scroll(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           _scroll_id = args.delete('scroll_id')

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

@@ -18,21 +18,19 @@ module OpenSearch
         # @option args [String] :id *Required* Pipeline ID.
         # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
         # @option args [String] :timeout Operation timeout.
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
         def delete(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
 
           _id = args.delete('id')
 
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = Utils.build_url('_search/pipeline', _id)
 
           Utils.validate_query_params! args, DELETE_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_QUERY_PARAMS = Set.new(%w[

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

@@ -22,7 +22,6 @@ module OpenSearch
         # @option args [String] :preference (default: random) Specifies the node or shard the operation should be performed on. Random by default.
         # @option args [Enumerable<String>, String] :routing Custom value used to route operations to a specific shard.
         # @option args [Enumerable<String>, String] :index Returns the indexes and shards that a search request would be executed against.
-        # @option args [Hash] :body Defines the parameters that can be used in the `search_shards` endpoint request. See documentation for supported query syntax.
         def search_shards(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           _index = args.delete('index')

data/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') || {}

data/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)

data/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)

data/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 = {})

data/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 = {})

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

@@ -15,7 +15,7 @@ module OpenSearch
       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)

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

@@ -15,7 +15,7 @@ module OpenSearch
       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)

data/lib/opensearch/api/actions/security/create_tenant.rb

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

data/lib/opensearch/api/actions/security/create_update_tenancy_config.rb

@@ -13,7 +13,7 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Creates or replaces the multi-tenancy configuration. Only accessible to admins and users with REST API permissions.
+        # Creates or replaces the multi-tenancy configuration. Requires super admin or REST API permissions.
         #
         # @option args [Hash] :body *Required*
         def create_update_tenancy_config(args = {})

data/lib/opensearch/api/actions/security/create_user.rb

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

data/lib/opensearch/api/actions/security/create_user_legacy.rb

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

data/lib/opensearch/api/actions/security/delete_action_group.rb

@@ -13,24 +13,22 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Delete a specified action group.
+        # Deletes the specified action group.
         #
         # @option args [String] :action_group *Required* The name of the action group to delete.
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
         def delete_action_group(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'action_group' missing" if args['action_group'].nil?
 
           _action_group = args.delete('action_group')
 
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = Utils.build_url('_plugins/_security/api/actiongroups', _action_group)
 
           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/security/delete_distinguished_name.rb

@@ -13,24 +13,22 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Deletes all distinguished names in the specified cluster or node allow list. Only accessible to super-admins and with rest-api permissions when enabled.
+        # Deletes all distinguished names in the specified cluster or node allowlist. Requires super admin or REST API permissions.
         #
-        # @option args [String] :cluster_name *Required* The cluster-name to delete from list of distinguished names.
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
+        # @option args [String] :cluster_name *Required* The cluster name to delete from list of distinguished names.
         def delete_distinguished_name(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'cluster_name' missing" if args['cluster_name'].nil?
 
           _cluster_name = args.delete('cluster_name')
 
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = Utils.build_url('_plugins/_security/api/nodesdn', _cluster_name)
 
           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/security/delete_role.rb

@@ -13,24 +13,22 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Delete the specified role.
+        # Deletes the specified role.
         #
         # @option args [String] :role *Required* The name of the role to delete.
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
         def delete_role(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'role' missing" if args['role'].nil?
 
           _role = args.delete('role')
 
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = Utils.build_url('_plugins/_security/api/roles', _role)
 
           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/security/delete_role_mapping.rb

@@ -15,22 +15,20 @@ module OpenSearch
       module Actions
         # Deletes the specified role mapping.
         #
-        # @option args [String] :role *Required* The name of the role whose mapping needs to delete.
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
+        # @option args [String] :role *Required* The name of the role for which to delete the role's mappings.
         def delete_role_mapping(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'role' missing" if args['role'].nil?
 
           _role = args.delete('role')
 
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = Utils.build_url('_plugins/_security/api/rolesmapping', _role)
 
           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/security/delete_tenant.rb

@@ -13,24 +13,22 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Delete the specified tenant.
+        # Deletes the specified tenant.
         #
         # @option args [String] :tenant *Required* The name of the tenant to delete.
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
         def delete_tenant(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'tenant' missing" if args['tenant'].nil?
 
           _tenant = args.delete('tenant')
 
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = Utils.build_url('_plugins/_security/api/tenants', _tenant)
 
           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/security/delete_user.rb

@@ -13,24 +13,22 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Delete the specified user.
+        # Deletes the specified internal user.
         #
         # @option args [String] :username *Required* The name of the user to delete.
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
         def delete_user(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'username' missing" if args['username'].nil?
 
           _username = args.delete('username')
 
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = Utils.build_url('_plugins/_security/api/internalusers', _username)
 
           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/security/delete_user_legacy.rb

@@ -16,21 +16,19 @@ module OpenSearch
         # Delete the specified user. Legacy API.
         #
         # @option args [String] :username *Required* The name of the user to delete.
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
         def delete_user_legacy(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'username' missing" if args['username'].nil?
 
           _username = args.delete('username')
 
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = Utils.build_url('_plugins/_security/api/user', _username)
 
           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/security/flush_cache.rb

@@ -13,19 +13,17 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Flushes the Security plugin user, authentication, and authorization cache.
+        # Flushes the Security plugin's user, authentication, and authorization cache.
         #
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
         def flush_cache(args = {})
           args = Utils.clone_and_normalize_arguments(args)
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = '_plugins/_security/api/cache'
 
           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/security/generate_obo_token.rb

@@ -13,7 +13,7 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Generates On-Behalf-Of token for the current user.
+        # Generates a `On-Behalf-Of` token for the current user.
         #
         # @option args [Hash] :body *Required*
         def generate_obo_token(args = {})

data/lib/opensearch/api/actions/security/generate_user_token.rb

@@ -13,9 +13,9 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Generates authorization token for the given user.
+        # Generates an authorization token for the specified user.
         #
-        # @option args [String] :username *Required* The name of the user for whom an auth token is to be vended.
+        # @option args [String] :username *Required* The name of the user for whom to issue an authorization token.
         def generate_user_token(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'username' missing" if args['username'].nil?

data/lib/opensearch/api/actions/security/generate_user_token_legacy.rb

@@ -15,7 +15,7 @@ module OpenSearch
       module Actions
         # Generates authorization token for the given user. Legacy API. Not Implemented.
         #
-        # @option args [String] :username *Required* The name of the user for whom an auth token is to be vended.
+        # @option args [String] :username *Required* The name of the user for whom to issue an authorization token.
         def generate_user_token_legacy(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'username' missing" if args['username'].nil?

data/lib/opensearch/api/actions/security/get_account_details.rb

@@ -13,7 +13,7 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Returns account details for the current user.
+        # Returns account information for the current user.
         #
         def get_account_details(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/security/get_all_certificates.rb

@@ -15,8 +15,8 @@ module OpenSearch
       module Actions
         # Retrieves the cluster security certificates.
         #
-        # @option args [String] :cert_type The type of certificates (HTTP, TRANSPORT, ALL) to retrieve from all nodes.
-        # @option args [String] :timeout The maximum duration, in seconds, to be spent to retrieve certificates from all nodes.
+        # @option args [String] :cert_type The type of certificates (`HTTP`, `TRANSPORT`, or `ALL`) to retrieve from all nodes.
+        # @option args [String] :timeout The maximum duration, in seconds, to spend retrieving certificates from all nodes before a timeout.
         def get_all_certificates(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}

data/lib/opensearch/api/actions/security/get_allowlist.rb

@@ -13,7 +13,7 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Retrieves the current list of allowed API accessible to normal user.
+        # Retrieves the current list of allowed APIs accessible to a normal user.
         #
         def get_allowlist(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/security/get_configuration.rb

@@ -13,7 +13,7 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Returns the current Security plugin configuration in JSON format.
+        # Returns the current Security plugin configuration in a JSON format.
         #
         def get_configuration(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/security/get_dashboards_info.rb

@@ -13,7 +13,7 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Retrieves the current security-dashboards plugin configuration.
+        # Retrieves the current values for dynamic security settings for OpenSearch Dashboards.
         #
         def get_dashboards_info(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/security/get_distinguished_name.rb

@@ -13,10 +13,10 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Retrieves distinguished names. Only accessible to super-admins and with rest-api permissions when enabled.
+        # Retrieves all node distinguished names. Requires super admin or REST API permissions.
         #
-        # @option args [String] :cluster_name *Required* The cluster-name to retrieve nodes DN setting for.
-        # @option args [Boolean] :show_all A Boolean flag to include/exclude static nodes DN from final result.
+        # @option args [String] :cluster_name *Required* The name of the cluster to retrieve that cluster's nodes DN settings.
+        # @option args [Boolean] :show_all Whether to include or exclude any static node's DN settings from the final result.
         def get_distinguished_name(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'cluster_name' missing" if args['cluster_name'].nil?

data/lib/opensearch/api/actions/security/get_distinguished_names.rb

@@ -13,9 +13,9 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Retrieves distinguished names. Only accessible to super-admins and with rest-api permissions when enabled.
+        # Retrieves all node distinguished names. Requires super admin or REST API permissions.
         #
-        # @option args [Boolean] :show_all A Boolean flag to include/exclude static nodes DN from final result.
+        # @option args [Boolean] :show_all Whether to include or exclude any static node's DN settings from the final result.
         def get_distinguished_names(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}

data/lib/opensearch/api/actions/security/get_node_certificates.rb

@@ -13,11 +13,11 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Retrieves the given node's security certificates.
+        # Retrieves the specified node's security certificates.
         #
-        # @option args [String] :node_id *Required* The full-id of the node to retrieve certificates.
-        # @option args [String] :cert_type The type of certificates (HTTP, TRANSPORT, ALL) to retrieve for a node.
-        # @option args [String] :timeout The maximum duration, in seconds, to be spent to retrieve a node's certificates.
+        # @option args [String] :node_id *Required* The node ID to retrieve certificates for.
+        # @option args [String] :cert_type The type of certificates (`HTTP`, `TRANSPORT`, or `ALL`) to retrieve from a node.
+        # @option args [String] :timeout The maximum duration, in seconds, to spend retrieving certificates from all nodes before a timeout.
         def get_node_certificates(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'node_id' missing" if args['node_id'].nil?

data/lib/opensearch/api/actions/security/get_permissions_info.rb

@@ -13,7 +13,7 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Gets the evaluated REST API permissions for the currently logged in user.
+        # Retrieves the evaluated REST API permissions for the currently logged in user.
         #
         def get_permissions_info(args = {})
           args = Utils.clone_and_normalize_arguments(args)

data/lib/opensearch/api/actions/security/get_role.rb

@@ -15,7 +15,7 @@ module OpenSearch
       module Actions
         # Retrieves one role.
         #
-        # @option args [String] :role *Required*
+        # @option args [String] :role *Required* The name of the role to retrieve.
         def get_role(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'role' missing" if args['role'].nil?

data/lib/opensearch/api/actions/security/get_role_mapping.rb

@@ -13,9 +13,9 @@ module OpenSearch
   module API
     module Security
       module Actions
-        # Retrieves one role mapping.
+        # Retrieves the specified role mapping.
         #
-        # @option args [String] :role *Required*
+        # @option args [String] :role *Required* The name of the role mapping to retrieve.
         def get_role_mapping(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'role' missing" if args['role'].nil?