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

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

@@ -0,0 +1,43 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        # Retrieves the specified node's security 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?
+
+          _node_id = args.delete('node_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_security/api/certificates', _node_id)
+
+          Utils.validate_query_params! args, GET_NODE_CERTIFICATES_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        GET_NODE_CERTIFICATES_QUERY_PARAMS = Set.new(%w[
+          cert_type
+          timeout
+        ]).freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        # Retrieves the evaluated REST API permissions for the currently logged in user.
+        #
+        def get_permissions_info(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_security/api/permissionsinfo'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -4,8 +4,8 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-# This code was generated from OpenSearch API Spec.
-# Update the code generation logic instead of modifying this file directly.
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
 # frozen_string_literal: true
 
@@ -13,27 +13,22 @@ module OpenSearch
   module API
     module Security
       module Actions
-        GET_ROLE_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Retrieves one role.
         #
-        # @option arguments [String] :role *Required*
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-role]
-        def get_role(arguments = {})
-          raise ArgumentError, "Required argument 'role' missing" unless arguments[:role]
+        # @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?
 
-          arguments = arguments.clone
-          _role = arguments.delete(:role)
+          _role = args.delete('role')
 
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'roles', _role
-          method  = OpenSearch::API::HTTP_GET
-          params  = Utils.__validate_and_extract_params arguments, GET_ROLE_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_security/api/roles', _role)
 
-          perform_request_complex_ignore404(method, url, params, body, headers, arguments)
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
         end
       end
     end

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

@@ -4,8 +4,8 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-# This code was generated from OpenSearch API Spec.
-# Update the code generation logic instead of modifying this file directly.
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
 # frozen_string_literal: true
 
@@ -13,27 +13,22 @@ module OpenSearch
   module API
     module Security
       module Actions
-        GET_ROLE_MAPPING_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Retrieves one role mapping.
-        #
-        # @option arguments [String] :role *Required*
+        # Retrieves the specified role mapping.
         #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-role-mapping]
-        def get_role_mapping(arguments = {})
-          raise ArgumentError, "Required argument 'role' missing" unless arguments[:role]
+        # @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?
 
-          arguments = arguments.clone
-          _role = arguments.delete(:role)
+          _role = args.delete('role')
 
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'rolesmapping', _role
-          method  = OpenSearch::API::HTTP_GET
-          params  = Utils.__validate_and_extract_params arguments, GET_ROLE_MAPPING_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_security/api/rolesmapping', _role)
 
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
         end
       end
     end

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

@@ -4,8 +4,8 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-# This code was generated from OpenSearch API Spec.
-# Update the code generation logic instead of modifying this file directly.
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
 # frozen_string_literal: true
 
@@ -13,22 +13,17 @@ module OpenSearch
   module API
     module Security
       module Actions
-        GET_ROLE_MAPPINGS_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Retrieves all role mappings.
         #
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-role-mappings]
-        def get_role_mappings(arguments = {})
-          arguments = arguments.clone
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'rolesmapping'
-          method  = OpenSearch::API::HTTP_GET
-          params  = Utils.__validate_and_extract_params arguments, GET_ROLE_MAPPINGS_QUERY_PARAMS
+        def get_role_mappings(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_security/api/rolesmapping'
 
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
         end
       end
     end

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

@@ -4,8 +4,8 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-# This code was generated from OpenSearch API Spec.
-# Update the code generation logic instead of modifying this file directly.
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
 # frozen_string_literal: true
 
@@ -13,22 +13,17 @@ module OpenSearch
   module API
     module Security
       module Actions
-        GET_ROLES_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Retrieves all roles.
         #
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-roles]
-        def get_roles(arguments = {})
-          arguments = arguments.clone
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'roles'
-          method  = OpenSearch::API::HTTP_GET
-          params  = Utils.__validate_and_extract_params arguments, GET_ROLES_QUERY_PARAMS
+        def get_roles(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_security/api/roles'
 
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
         end
       end
     end

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

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        # Retrieves information about the SSL configuration.
+        #
+        # @option args [Hash] :show_dn Whether to include all domain names in the response.
+        def get_sslinfo(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_opendistro/_security/sslinfo'
+
+          Utils.validate_query_params! args, GET_SSLINFO_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        GET_SSLINFO_QUERY_PARAMS = Set.new(%w[
+          show_dn
+        ]).freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        # Retrieves the multi-tenancy configuration. Requires super admin or REST API permissions.
+        #
+        def get_tenancy_config(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_security/api/tenancy/config'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -4,8 +4,8 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-# This code was generated from OpenSearch API Spec.
-# Update the code generation logic instead of modifying this file directly.
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
 # frozen_string_literal: true
 
@@ -13,27 +13,22 @@ module OpenSearch
   module API
     module Security
       module Actions
-        GET_TENANT_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Retrieves one tenant.
-        #
-        # @option arguments [String] :tenant *Required*
+        # Retrieves the specified tenant.
         #
-        # {API Reference}[https://opensearch.org/docs/2.7/security/access-control/api/#get-tenant]
-        def get_tenant(arguments = {})
-          raise ArgumentError, "Required argument 'tenant' missing" unless arguments[:tenant]
+        # @option args [String] :tenant *Required* The name of the tenant to retrieve.
+        def get_tenant(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'tenant' missing" if args['tenant'].nil?
 
-          arguments = arguments.clone
-          _tenant = arguments.delete(:tenant)
+          _tenant = args.delete('tenant')
 
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'tenants', _tenant
-          method  = OpenSearch::API::HTTP_GET
-          params  = Utils.__validate_and_extract_params arguments, GET_TENANT_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_security/api/tenants', _tenant)
 
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
         end
       end
     end

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

@@ -4,8 +4,8 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-# This code was generated from OpenSearch API Spec.
-# Update the code generation logic instead of modifying this file directly.
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
 # frozen_string_literal: true
 
@@ -13,22 +13,17 @@ module OpenSearch
   module API
     module Security
       module Actions
-        GET_TENANTS_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Retrieves all tenants.
         #
-        #
-        # {API Reference}[https://opensearch.org/docs/2.7/security/access-control/api/#get-tenants]
-        def get_tenants(arguments = {})
-          arguments = arguments.clone
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'tenants'
-          method  = OpenSearch::API::HTTP_GET
-          params  = Utils.__validate_and_extract_params arguments, GET_TENANTS_QUERY_PARAMS
+        def get_tenants(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_security/api/tenants'
 
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
         end
       end
     end

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

@@ -4,8 +4,8 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-# This code was generated from OpenSearch API Spec.
-# Update the code generation logic instead of modifying this file directly.
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
 # frozen_string_literal: true
 
@@ -13,27 +13,22 @@ module OpenSearch
   module API
     module Security
       module Actions
-        GET_USER_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Retrieve one internal user.
-        #
-        # @option arguments [String] :username *Required*
+        # Retrieve information about the specified internal user.
         #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-user]
-        def get_user(arguments = {})
-          raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
+        # @option args [String] :username *Required* The name of the user to retrieve.
+        def get_user(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'username' missing" if args['username'].nil?
 
-          arguments = arguments.clone
-          _username = arguments.delete(:username)
+          _username = args.delete('username')
 
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'internalusers', _username
-          method  = OpenSearch::API::HTTP_GET
-          params  = Utils.__validate_and_extract_params arguments, GET_USER_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_security/api/internalusers', _username)
 
-          perform_request_complex_ignore404(method, url, params, body, headers, arguments)
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
         end
       end
     end

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

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        # Retrieve one user. Legacy API.
+        #
+        # @option args [String] :username *Required* The name of the user to retrieve.
+        def get_user_legacy(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'username' missing" if args['username'].nil?
+
+          _username = args.delete('username')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_security/api/user', _username)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -4,8 +4,8 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-# This code was generated from OpenSearch API Spec.
-# Update the code generation logic instead of modifying this file directly.
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
 # frozen_string_literal: true
 
@@ -13,22 +13,17 @@ module OpenSearch
   module API
     module Security
       module Actions
-        GET_USERS_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Retrieve all internal users.
         #
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-users]
-        def get_users(arguments = {})
-          arguments = arguments.clone
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'internalusers'
-          method  = OpenSearch::API::HTTP_GET
-          params  = Utils.__validate_and_extract_params arguments, GET_USERS_QUERY_PARAMS
+        def get_users(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_security/api/internalusers'
 
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
         end
       end
     end

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

@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        # Retrieve all internal users. Legacy API.
+        #
+        def get_users_legacy(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_security/api/user'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -4,8 +4,8 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-# This code was generated from OpenSearch API Spec.
-# Update the code generation logic instead of modifying this file directly.
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
 # frozen_string_literal: true
 
@@ -13,23 +13,23 @@ module OpenSearch
   module API
     module Security
       module Actions
-        HEALTH_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Checks to see if the Security plugin is up and running.
-        #
+        # Checks to see if the Security plugin is running.
         #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#health-check]
-        def health(arguments = {})
-          arguments = arguments.clone
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'health'
-          method  = OpenSearch::API::HTTP_GET
-          params  = Utils.__validate_and_extract_params arguments, HEALTH_QUERY_PARAMS
+        # @option args [String] :mode A flag that determines whether to consider the security status before returning a response for a health query response. For example, `strict` mode indicates service should check the Security plugin status.
+        def health(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = body ? 'POST' : 'GET'
+          url     = '_plugins/_security/health'
 
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args, HEALTH_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
+
+        HEALTH_QUERY_PARAMS = Set.new(%w[
+          mode
+        ]).freeze
       end
     end
   end