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

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

@@ -0,0 +1,34 @@
+# 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
+        # 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 = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = '_plugins/_security/api/allowlist'
+
+          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/create_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,29 +13,24 @@ module OpenSearch
   module API
     module Security
       module Actions
-        CREATE_ROLE_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Creates or replaces the specified role.
         #
-        # @option arguments [String] :role *Required*
-        # @option arguments [Hash] :body *Required*
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#create-role]
-        def create_role(arguments = {})
-          raise ArgumentError, "Required argument 'role' missing" unless arguments[:role]
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        # @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)
+          raise ArgumentError, "Required argument 'role' missing" if args['role'].nil?
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].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_PUT
-          params  = Utils.__validate_and_extract_params arguments, CREATE_ROLE_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = Utils.build_url('_plugins/_security/api/roles', _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/create_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,29 +13,24 @@ module OpenSearch
   module API
     module Security
       module Actions
-        CREATE_ROLE_MAPPING_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Creates or replaces the specified role mapping.
         #
-        # @option arguments [String] :role *Required*
-        # @option arguments [Hash] :body *Required*
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping]
-        def create_role_mapping(arguments = {})
-          raise ArgumentError, "Required argument 'role' missing" unless arguments[:role]
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        # @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)
+          raise ArgumentError, "Required argument 'role' missing" if args['role'].nil?
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].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_PUT
-          params  = Utils.__validate_and_extract_params arguments, CREATE_ROLE_MAPPING_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          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/create_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,28 +13,24 @@ module OpenSearch
   module API
     module Security
       module Actions
-        CREATE_TENANT_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Creates or replaces the specified tenant.
         #
-        # @option arguments [String] :tenant *Required*
-        # @option arguments [Hash] :body
-        #
-        # {API Reference}[https://opensearch.org/docs/2.7/security/access-control/api/#create-tenant]
-        def create_tenant(arguments = {})
-          raise ArgumentError, "Required argument 'tenant' missing" unless arguments[:tenant]
+        # @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)
+          raise ArgumentError, "Required argument 'tenant' missing" if args['tenant'].nil?
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].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_PUT
-          params  = Utils.__validate_and_extract_params arguments, CREATE_TENANT_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          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/create_update_tenancy_config.rb

@@ -0,0 +1,34 @@
+# 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
+        # 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 = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          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/create_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,29 +13,24 @@ module OpenSearch
   module API
     module Security
       module Actions
-        CREATE_USER_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Creates or replaces the specified user.
         #
-        # @option arguments [String] :username *Required*
-        # @option arguments [Hash] :body *Required*
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#create-user]
-        def create_user(arguments = {})
-          raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        # @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)
+          raise ArgumentError, "Required argument 'username' missing" if args['username'].nil?
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].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_PUT
-          params  = Utils.__validate_and_extract_params arguments, CREATE_USER_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = Utils.build_url('_plugins/_security/api/internalusers', _username)
 
-          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/create_user_legacy.rb

@@ -0,0 +1,38 @@
+# 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
+        # Creates or replaces the specified user. Legacy API.
+        #
+        # @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)
+          raise ArgumentError, "Required argument 'username' missing" if args['username'].nil?
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          _username = args.delete('username')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          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/delete_action_group.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
-        DELETE_ACTION_GROUP_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Delete a specified action group.
-        #
-        # @option arguments [String] :action_group *Required* Action group to delete.
+        # Deletes the specified action group.
         #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group]
-        def delete_action_group(arguments = {})
-          raise ArgumentError, "Required argument 'action_group' missing" unless arguments[:action_group]
+        # @option args [String] :action_group *Required* The name of the action group to delete.
+        def delete_action_group(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'action_group' missing" if args['action_group'].nil?
 
-          arguments = arguments.clone
-          _action_group = arguments.delete(:action_group)
+          _action_group = args.delete('action_group')
 
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'actiongroups', _action_group
-          method  = OpenSearch::API::HTTP_DELETE
-          params  = Utils.__validate_and_extract_params arguments, DELETE_ACTION_GROUP_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = Utils.build_url('_plugins/_security/api/actiongroups', _action_group)
 
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args
+          transport.perform_delete_request method, url, args, body, headers
         end
       end
     end

data/lib/opensearch/api/actions/security/delete_distinguished_name.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
+        # 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.
+        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')
+
+          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
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/delete_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
-        DELETE_ROLE_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Delete the specified role.
-        #
-        # @option arguments [String] :role *Required*
+        # Deletes the specified role.
         #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#delete-role]
-        def delete_role(arguments = {})
-          raise ArgumentError, "Required argument 'role' missing" unless arguments[:role]
+        # @option args [String] :role *Required* The name of the role to delete.
+        def delete_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_DELETE
-          params  = Utils.__validate_and_extract_params arguments, DELETE_ROLE_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = Utils.build_url('_plugins/_security/api/roles', _role)
 
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args
+          transport.perform_delete_request method, url, args, body, headers
         end
       end
     end

data/lib/opensearch/api/actions/security/delete_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
-        DELETE_ROLE_MAPPING_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Deletes the specified role mapping.
         #
-        # @option arguments [String] :role *Required*
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#delete-role-mapping]
-        def delete_role_mapping(arguments = {})
-          raise ArgumentError, "Required argument 'role' missing" unless arguments[:role]
+        # @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?
 
-          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_DELETE
-          params  = Utils.__validate_and_extract_params arguments, DELETE_ROLE_MAPPING_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = Utils.build_url('_plugins/_security/api/rolesmapping', _role)
 
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args
+          transport.perform_delete_request method, url, args, body, headers
         end
       end
     end

data/lib/opensearch/api/actions/security/delete_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
-        DELETE_TENANT_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Delete the specified tenant.
-        #
-        # @option arguments [String] :tenant *Required*
+        # Deletes the specified tenant.
         #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group]
-        def delete_tenant(arguments = {})
-          raise ArgumentError, "Required argument 'tenant' missing" unless arguments[:tenant]
+        # @option args [String] :tenant *Required* The name of the tenant to delete.
+        def delete_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_DELETE
-          params  = Utils.__validate_and_extract_params arguments, DELETE_TENANT_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = Utils.build_url('_plugins/_security/api/tenants', _tenant)
 
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args
+          transport.perform_delete_request method, url, args, body, headers
         end
       end
     end

data/lib/opensearch/api/actions/security/delete_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
-        DELETE_USER_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Delete the specified user.
-        #
-        # @option arguments [String] :username *Required*
+        # Deletes the specified internal user.
         #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#delete-user]
-        def delete_user(arguments = {})
-          raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
+        # @option args [String] :username *Required* The name of the user to delete.
+        def delete_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_DELETE
-          params  = Utils.__validate_and_extract_params arguments, DELETE_USER_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = Utils.build_url('_plugins/_security/api/internalusers', _username)
 
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args
+          transport.perform_delete_request method, url, args, body, headers
         end
       end
     end