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

data/lib/opensearch/api/actions/security/delete_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
+        # Delete the specified user. Legacy API.
+        #
+        # @option args [String] :username *Required* The name of the user to delete.
+        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')
+
+          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
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/flush_cache.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
-        FLUSH_CACHE_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Flushes the Security plugin user, authentication, and authorization cache.
-        #
+        # Flushes the Security plugin's user, authentication, and authorization cache.
         #
-        # {API Reference}[https://opensearch.org/docs/2.7/security/access-control/api/#flush-cache]
-        def flush_cache(arguments = {})
-          arguments = arguments.clone
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'cache'
-          method  = OpenSearch::API::HTTP_DELETE
-          params  = Utils.__validate_and_extract_params arguments, FLUSH_CACHE_QUERY_PARAMS
+        def flush_cache(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = '_plugins/_security/api/cache'
 
-          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/generate_obo_token.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
+        # Generates a `On-Behalf-Of` token for the current user.
+        #
+        # @option args [Hash] :body *Required*
+        def generate_obo_token(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  = 'POST'
+          url     = '_plugins/_security/api/generateonbehalfoftoken'
+
+          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/generate_user_token.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
+        # Generates an authorization token for the specified user.
+        #
+        # @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?
+
+          _username = args.delete('username')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_plugins/_security/api/internalusers', _username, 'authtoken')
+
+          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/generate_user_token_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
+        # Generates authorization token for the given user. Legacy API. Not Implemented.
+        #
+        # @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?
+
+          _username = args.delete('username')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_plugins/_security/api/user', _username, 'authtoken')
+
+          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_account_details.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_ACCOUNT_DETAILS_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Returns account details for the current user.
-        #
+        # Returns account information for the current user.
         #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-account-details]
-        def get_account_details(arguments = {})
-          arguments = arguments.clone
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'account'
-          method  = OpenSearch::API::HTTP_GET
-          params  = Utils.__validate_and_extract_params arguments, GET_ACCOUNT_DETAILS_QUERY_PARAMS
+        def get_account_details(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_security/api/account'
 
-          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_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
-        GET_ACTION_GROUP_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Retrieves one action group.
         #
-        # @option arguments [String] :action_group *Required* Action group to retrieve.
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-action-group]
-        def get_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 retrieve.
+        def get_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_GET
-          params  = Utils.__validate_and_extract_params arguments, GET_ACTION_GROUP_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          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/get_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,22 +13,17 @@ module OpenSearch
   module API
     module Security
       module Actions
-        GET_ACTION_GROUPS_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Retrieves all action groups.
         #
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-action-groups]
-        def get_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_GET
-          params  = Utils.__validate_and_extract_params arguments, GET_ACTION_GROUPS_QUERY_PARAMS
+        def get_action_groups(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          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/get_all_certificates.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
+        # Retrieves the cluster security certificates.
+        #
+        # @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') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_security/api/certificates'
+
+          Utils.validate_query_params! args, GET_ALL_CERTIFICATES_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        GET_ALL_CERTIFICATES_QUERY_PARAMS = Set.new(%w[
+          cert_type
+          timeout
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/get_allowlist.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 current list of allowed APIs accessible to a normal user.
+        #
+        def get_allowlist(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          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/get_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,22 +13,17 @@ module OpenSearch
   module API
     module Security
       module Actions
-        GET_AUDIT_CONFIGURATION_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Retrieves the audit configuration.
         #
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#audit-logs]
-        def get_audit_configuration(arguments = {})
-          arguments = arguments.clone
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'audit'
-          method  = OpenSearch::API::HTTP_GET
-          params  = Utils.__validate_and_extract_params arguments, GET_AUDIT_CONFIGURATION_QUERY_PARAMS
+        def get_audit_configuration(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          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

data/lib/opensearch/api/actions/security/get_certificates.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_CERTIFICATES_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Retrieves the cluster’s security certificates.
-        #
+        # Retrieves the cluster security certificates.
         #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-certificates]
-        def get_certificates(arguments = {})
-          arguments = arguments.clone
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'ssl', 'certs'
-          method  = OpenSearch::API::HTTP_GET
-          params  = Utils.__validate_and_extract_params arguments, GET_CERTIFICATES_QUERY_PARAMS
+        def get_certificates(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_security/api/ssl/certs'
 
-          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_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,22 +13,17 @@ module OpenSearch
   module API
     module Security
       module Actions
-        GET_CONFIGURATION_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Returns the current Security plugin configuration in JSON format.
-        #
+        # Returns the current Security plugin configuration in a JSON format.
         #
-        # {API Reference}[https://opensearch.org/docs/2.7/security/access-control/api/#get-configuration]
-        def get_configuration(arguments = {})
-          arguments = arguments.clone
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'securityconfig'
-          method  = OpenSearch::API::HTTP_GET
-          params  = Utils.__validate_and_extract_params arguments, GET_CONFIGURATION_QUERY_PARAMS
+        def get_configuration(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_security/api/securityconfig'
 
-          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_dashboards_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 current values for dynamic security settings for OpenSearch Dashboards.
+        #
+        def get_dashboards_info(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_security/dashboardsinfo'
+
+          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_distinguished_name.rb

@@ -0,0 +1,41 @@
+# 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 all node distinguished names. Requires super admin or REST API permissions.
+        #
+        # @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?
+
+          _cluster_name = args.delete('cluster_name')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_security/api/nodesdn', _cluster_name)
+
+          Utils.validate_query_params! args, GET_DISTINGUISHED_NAME_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        GET_DISTINGUISHED_NAME_QUERY_PARAMS = Set.new(%w[
+          show_all
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/get_distinguished_names.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,26 +13,23 @@ module OpenSearch
   module API
     module Security
       module Actions
-        GET_DISTINGUISHED_NAMES_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Retrieves all distinguished names in the allow list.
-        #
-        # @option arguments [String] :cluster_name
+        # Retrieves all node distinguished names. Requires super admin or REST API permissions.
         #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names]
-        def get_distinguished_names(arguments = {})
-          arguments = arguments.clone
-          _cluster_name = arguments.delete(:cluster_name)
+        # @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') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_security/api/nodesdn'
 
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'nodesdn', _cluster_name
-          method  = OpenSearch::API::HTTP_GET
-          params  = Utils.__validate_and_extract_params arguments, GET_DISTINGUISHED_NAMES_QUERY_PARAMS
-
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args, GET_DISTINGUISHED_NAMES_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
+
+        GET_DISTINGUISHED_NAMES_QUERY_PARAMS = Set.new(%w[
+          show_all
+        ]).freeze
       end
     end
   end