opensearch-ruby 2.1.0 → 3.0.0

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

@@ -0,0 +1,39 @@
+# 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 code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        PATCH_ROLES_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Creates, updates, or deletes multiple roles in a single call.
+        #
+        # @option arguments [Hash] :body *Required*
+        #
+        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#patch-roles]
+        def patch_roles(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'roles'
+          method  = OpenSearch::API::HTTP_PATCH
+          params  = Utils.__validate_and_extract_params arguments, PATCH_ROLES_QUERY_PARAMS
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        PATCH_TENANT_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Add, delete, or modify a single tenant.
+        #
+        # @option arguments [String] :tenant *Required*
+        # @option arguments [Hash] :body *Required*
+        #
+        # {API Reference}[https://opensearch.org/docs/2.7/security/access-control/api/#patch-tenant]
+        def patch_tenant(arguments = {})
+          raise ArgumentError, "Required argument 'tenant' missing" unless arguments[:tenant]
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
+          _tenant = arguments.delete(:tenant)
+
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'tenants', _tenant
+          method  = OpenSearch::API::HTTP_PATCH
+          params  = Utils.__validate_and_extract_params arguments, PATCH_TENANT_QUERY_PARAMS
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# 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 code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+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*
+        #
+        # {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]
+
+          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
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+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*
+        #
+        # {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]
+
+          arguments = arguments.clone
+          _username = arguments.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
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# 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 code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+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*
+        #
+        # {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]
+
+          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
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/reload_http_certificates.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 code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        RELOAD_HTTP_CERTIFICATES_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Reload HTTP layer 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
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/reload_transport_certificates.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 code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        RELOAD_TRANSPORT_CERTIFICATES_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Reload transport layer 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
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# 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 code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+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]
+
+          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
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# 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 code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+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*
+        #
+        # {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]
+
+          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
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# 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 code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        UPDATE_DISTINGUISHED_NAMES_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Adds or updates the specified distinguished names in the cluster’s or node’s allow list.
+        #
+        # @option arguments [String] :cluster_name *Required*
+        # @option arguments [Hash] :body
+        #
+        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names]
+        def update_distinguished_names(arguments = {})
+          raise ArgumentError, "Required argument 'cluster_name' missing" unless arguments[:cluster_name]
+
+          arguments = arguments.clone
+          _cluster_name = arguments.delete(:cluster_name)
+
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'nodesdn', _cluster_name
+          method  = OpenSearch::API::HTTP_PUT
+          params  = Utils.__validate_and_extract_params arguments, UPDATE_DISTINGUISHED_NAMES_QUERY_PARAMS
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/shutdown/delete_node.rb

@@ -0,0 +1,60 @@
+# 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.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module API
+    module Shutdown
+      module Actions
+        # Removes a node from the shutdown list
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. OpenSearch will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :node_id The node id of node to be removed from the shutdown state
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        #
+        def delete_node(arguments = {})
+          raise ArgumentError, "Required argument 'node_id' missing" unless arguments[:node_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          method = OpenSearch::API::HTTP_DELETE
+          path   = "_nodes/#{Utils.__listify(_node_id)}/shutdown"
+          params = {}
+
+          body = nil
+          perform_request(method, path, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/shutdown/get_node.rb

@@ -0,0 +1,62 @@
+# 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.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module API
+    module Shutdown
+      module Actions
+        # Retrieve status of a node or nodes that are currently marked as shutting down
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. OpenSearch will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :node_id Which node for which to retrieve the shutdown status
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        #
+        def get_node(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          method = OpenSearch::API::HTTP_GET
+          path   = if _node_id
+                     "_nodes/#{Utils.__listify(_node_id)}/shutdown"
+                   else
+                     '_nodes/shutdown'
+                   end
+          params = {}
+
+          body = nil
+          perform_request(method, path, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/shutdown/params_registry.rb

@@ -0,0 +1,69 @@
+# 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.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module API
+    module Shutdown
+      module Actions
+        module ParamsRegistry
+          extend self
+
+          # A Mapping of all the actions to their list of valid params.
+          #
+          # @since 6.1.1
+          PARAMS = {}
+
+          # Register an action with its list of valid params.
+          #
+          # @example Register the action.
+          #   ParamsRegistry.register(:benchmark, [ :verbose ])
+          #
+          # @param [ Symbol ] action The action to register.
+          # @param [ Array[Symbol] ] valid_params The list of valid params.
+          #
+          # @since 6.1.1
+          def register(action, valid_params)
+            PARAMS[action.to_sym] = valid_params
+          end
+
+          # Get the list of valid params for a given action.
+          #
+          # @example Get the list of valid params.
+          #   ParamsRegistry.get(:benchmark)
+          #
+          # @param [ Symbol ] action The action.
+          #
+          # @return [ Array<Symbol> ] The list of valid params for the action.
+          #
+          # @since 6.1.1
+          def get(action)
+            PARAMS.fetch(action, [])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/shutdown/put_node.rb

@@ -0,0 +1,62 @@
+# 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.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module API
+    module Shutdown
+      module Actions
+        # Adds a node to be shut down
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. OpenSearch will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :node_id The node id of node to be shut down
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The shutdown type definition to register (*Required*)
+        #
+        #
+        def put_node(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'node_id' missing" unless arguments[:node_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          method = OpenSearch::API::HTTP_PUT
+          path   = "_nodes/#{Utils.__listify(_node_id)}/shutdown"
+          params = {}
+
+          body = arguments[:body]
+          perform_request(method, path, params, body, headers).body
+        end
+      end
+    end
+  end
+end