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

data/lib/opensearch/api/actions/security/patch_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,25 +13,20 @@ module OpenSearch
   module API
     module Security
       module Actions
-        PATCH_TENANTS_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Add, delete, or modify multiple tenants in a single call.
-        #
-        # @option arguments [Hash] :body *Required*
+        # Adds, deletes, or modifies multiple tenants in a single request.
         #
-        # {API Reference}[https://opensearch.org/docs/2.7/security/access-control/api/#patch-tenants]
-        def patch_tenants(arguments = {})
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        # @option args [Enumerable<Hash>] :body *Required*
+        def patch_tenants(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', 'tenants'
-          method  = OpenSearch::API::HTTP_PATCH
-          params  = Utils.__validate_and_extract_params arguments, PATCH_TENANTS_QUERY_PARAMS
+          headers = (args.delete('headers') || {}).merge('Content-Type' => 'application/x-ndjson')
+          body    = Utils.bulkify(args.delete('body'))
+          method  = 'PATCH'
+          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/patch_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
-        PATCH_USER_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Updates individual attributes of an internal user.
-        #
-        # @option arguments [String] :username *Required*
-        # @option arguments [Hash] :body *Required*
+        # Updates individual attributes for an internal user.
         #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#patch-user]
-        def patch_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 update.
+        # @option args [Enumerable<Hash>] :body *Required*
+        def patch_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_PATCH
-          params  = Utils.__validate_and_extract_params arguments, PATCH_USER_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/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/patch_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,25 +13,20 @@ module OpenSearch
   module API
     module Security
       module Actions
-        PATCH_USERS_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Creates, updates, or deletes multiple internal users in a single call.
-        #
-        # @option arguments [Hash] :body *Required*
+        # Creates, updates, or deletes multiple internal users in a single request.
         #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#patch-users]
-        def patch_users(arguments = {})
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        # @option args [Enumerable<Hash>] :body *Required*
+        def patch_users(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', 'internalusers'
-          method  = OpenSearch::API::HTTP_PATCH
-          params  = Utils.__validate_and_extract_params arguments, PATCH_USERS_QUERY_PARAMS
+          headers = (args.delete('headers') || {}).merge('Content-Type' => 'application/x-ndjson')
+          body    = Utils.bulkify(args.delete('body'))
+          method  = 'PATCH'
+          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/post_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 post_dashboards_info(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          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/reload_http_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
-        RELOAD_HTTP_CERTIFICATES_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Reload HTTP layer communication certificates.
-        #
+        # Reloads the HTTP communication certificates.
         #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#reload-http-certificates]
-        def reload_http_certificates(arguments = {})
-          arguments = arguments.clone
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'ssl', 'http', 'reloadcerts'
-          method  = OpenSearch::API::HTTP_PUT
-          params  = Utils.__validate_and_extract_params arguments, RELOAD_HTTP_CERTIFICATES_QUERY_PARAMS
+        def reload_http_certificates(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = '_plugins/_security/api/ssl/http/reloadcerts'
 
-          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/reload_transport_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
-        RELOAD_TRANSPORT_CERTIFICATES_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Reload transport layer communication certificates.
-        #
+        # Reloads the transport communication certificates.
         #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#reload-transport-certificates]
-        def reload_transport_certificates(arguments = {})
-          arguments = arguments.clone
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'ssl', 'transport', 'reloadcerts'
-          method  = OpenSearch::API::HTTP_PUT
-          params  = Utils.__validate_and_extract_params arguments, RELOAD_TRANSPORT_CERTIFICATES_QUERY_PARAMS
+        def reload_transport_certificates(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = '_plugins/_security/api/ssl/transport/reloadcerts'
 
-          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/tenant_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 names of current tenants. Requires super admin or `kibanaserver` permissions.
+        #
+        def tenant_info(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = body ? 'POST' : 'GET'
+          url     = '_plugins/_security/tenantinfo'
+
+          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/update_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
-        UPDATE_AUDIT_CONFIGURATION_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Updates the audit configuration.
         #
-        # @option arguments [Hash] :body *Required*
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#audit-logs]
-        def update_audit_configuration(arguments = {})
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        # @option args [Hash] :body *Required*
+        def update_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', 'config'
-          method  = OpenSearch::API::HTTP_PUT
-          params  = Utils.__validate_and_extract_params arguments, UPDATE_AUDIT_CONFIGURATION_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = '_plugins/_security/api/audit/config'
 
-          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/update_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
-        UPDATE_CONFIGURATION_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
-        # Adds or updates the existing configuration using the REST API.
-        #
-        # @option arguments [Hash] :body *Required*
+        # Updates the settings for an existing security configuration. Requires super admin or REST API permissions.
         #
-        # {API Reference}[https://opensearch.org/docs/2.7/security/access-control/api/#update-configuration]
-        def update_configuration(arguments = {})
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        # @option args [Hash] :body *Required*
+        def update_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', 'securityconfig', 'config'
-          method  = OpenSearch::API::HTTP_PUT
-          params  = Utils.__validate_and_extract_params arguments, UPDATE_CONFIGURATION_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = '_plugins/_security/api/securityconfig/config'
 
-          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/update_distinguished_name.rb

@@ -0,0 +1,37 @@
+# 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
+        # Adds or updates the specified distinguished names in the cluster or node allowlist. Requires super admin or REST API permissions.
+        #
+        # @option args [String] :cluster_name *Required* The name of the cluster containing the `nodesDn` value to create or update.
+        # @option args [Hash] :body
+        def update_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  = 'PUT'
+          url     = Utils.build_url('_plugins/_security/api/nodesdn', _cluster_name)
+
+          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/validate.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
+        # Checks whether the v6 security configuration is valid and ready to be migrated to v7.
+        #
+        # @option args [Boolean] :accept_invalid Whether an invalid v6 configuration should be allowed.
+        def validate(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_security/api/validate'
+
+          Utils.validate_query_params! args, VALIDATE_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        VALIDATE_QUERY_PARAMS = Set.new(%w[
+          accept_invalid
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/who_am_i.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
+        # Gets the identity information for the user currently logged in.
+        #
+        def who_am_i(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = body ? 'POST' : 'GET'
+          url     = '_plugins/_security/whoami'
+
+          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/who_am_i_protected.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
+        # Gets the identity information for the user currently logged in. To use this operation, you must have access to this endpoint when authorization at REST layer is enabled.
+        #
+        def who_am_i_protected(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_security/whoamiprotected'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/sm/create_policy.rb

@@ -0,0 +1,37 @@
+# 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 Sm
+      module Actions
+        # Creates a snapshot management policy.
+        #
+        # @option args [String] :policy_name *Required* The name of the snapshot management policy.
+        # @option args [Hash] :body
+        def create_policy(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'policy_name' missing" if args['policy_name'].nil?
+
+          _policy_name = args.delete('policy_name')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_plugins/_sm/policies', _policy_name)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/sm/delete_policy.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 Sm
+      module Actions
+        # Deletes a snapshot management policy.
+        #
+        # @option args [String] :policy_name *Required* The name of the snapshot management policy.
+        def delete_policy(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'policy_name' missing" if args['policy_name'].nil?
+
+          _policy_name = args.delete('policy_name')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = Utils.build_url('_plugins/_sm/policies', _policy_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/sm/explain_policy.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 Sm
+      module Actions
+        # Explains the state of the snapshot management policy.
+        #
+        # @option args [String] :policy_name *Required* The name of the snapshot management policy.
+        def explain_policy(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'policy_name' missing" if args['policy_name'].nil?
+
+          _policy_name = args.delete('policy_name')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_sm/policies', _policy_name, '_explain')
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end