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

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 the SSL configuration information.
+        #
+        # @option args [Hash] :show_dn A Boolean flag to indicate whether all domain names should be returned.
+        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 multi-tenancy configuration. Only accessible to admins and users with 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*
-        #
-        # {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*
-        #
-        # {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.
         #
-        #
-        # {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 to indicate whether service should consider security-plugin's status before returning health response. `strict` mode indicates service should check 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

data/lib/opensearch/api/actions/security/migrate.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
+        # Migrates security configuration from v6 to v7.
+        #
+        def migrate(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_security/api/migrate'
+
+          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/patch_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,28 +13,24 @@ module OpenSearch
   module API
     module Security
       module Actions
-        PATCH_ACTION_GROUP_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Updates individual attributes of an action group.
         #
-        # @option arguments [String] :action_group *Required*
-        # @option arguments [Hash] :body
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#patch-action-group]
-        def patch_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 update.
+        # @option args [Enumerable<Hash>] :body *Required*
+        def patch_action_group(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'action_group' missing" if args['action_group'].nil?
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].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_PATCH
-          params  = Utils.__validate_and_extract_params arguments, PATCH_ACTION_GROUP_QUERY_PARAMS
+          headers = (args.delete('headers') || {}).merge('Content-Type' => 'application/x-ndjson')
+          body    = Utils.bulkify(args.delete('body'))
+          method  = 'PATCH'
+          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_request(method, url, args, body, headers).body
         end
       end
     end

data/lib/opensearch/api/actions/security/patch_action_groups.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,20 @@ module OpenSearch
   module API
     module Security
       module Actions
-        PATCH_ACTION_GROUPS_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Creates, updates, or deletes multiple action groups in a single call.
         #
-        # @option arguments [Hash] :body
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#patch-action-groups]
-        def patch_action_groups(arguments = {})
-          arguments = arguments.clone
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'actiongroups'
-          method  = OpenSearch::API::HTTP_PATCH
-          params  = Utils.__validate_and_extract_params arguments, PATCH_ACTION_GROUPS_QUERY_PARAMS
+        # @option args [Enumerable<Hash>] :body *Required*
+        def patch_action_groups(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          headers = (args.delete('headers') || {}).merge('Content-Type' => 'application/x-ndjson')
+          body    = Utils.bulkify(args.delete('body'))
+          method  = 'PATCH'
+          url     = '_plugins/_security/api/actiongroups'
 
-          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/patch_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
+        # Updates the current list of allowed API accessible to normal user.
+        #
+        # @option args [Enumerable<Hash>] :body *Required*
+        def patch_allowlist(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          headers = (args.delete('headers') || {}).merge('Content-Type' => 'application/x-ndjson')
+          body    = Utils.bulkify(args.delete('body'))
+          method  = 'PATCH'
+          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/patch_audit_configuration.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,25 +13,20 @@ module OpenSearch
   module API
     module Security
       module Actions
-        PATCH_AUDIT_CONFIGURATION_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # A PATCH call is used to update specified fields in the audit configuration.
         #
-        # @option arguments [Hash] :body *Required*
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#audit-logs]
-        def patch_audit_configuration(arguments = {})
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        # @option args [Enumerable<Hash>] :body *Required*
+        def patch_audit_configuration(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
 
-          arguments = arguments.clone
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'audit'
-          method  = OpenSearch::API::HTTP_PATCH
-          params  = Utils.__validate_and_extract_params arguments, PATCH_AUDIT_CONFIGURATION_QUERY_PARAMS
+          headers = (args.delete('headers') || {}).merge('Content-Type' => 'application/x-ndjson')
+          body    = Utils.bulkify(args.delete('body'))
+          method  = 'PATCH'
+          url     = '_plugins/_security/api/audit'
 
-          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