opensearch-api 1.0.0

data/lib/opensearch/api/actions/msearch.rb

@@ -0,0 +1,112 @@
+# 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 Actions
+      # Allows to execute several search operations in one request.
+      #
+      # @option arguments [List] :index A comma-separated list of index names to use as default
+      # @option arguments [List] :type A comma-separated list of document types to use as default
+      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
+      # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
+      # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
+      # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
+      # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
+      # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
+      # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs), separated by newlines (*Required*)
+      #
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
+      #
+      #
+      #
+      def msearch(arguments = {})
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        _type = arguments.delete(:type)
+
+        method = OpenSearch::API::HTTP_POST
+        path   = if _index && _type
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_msearch"
+                 elsif _index
+                   "#{Utils.__listify(_index)}/_msearch"
+                 else
+                   "_msearch"
+                 end
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+        body = arguments[:body]
+        case
+        when body.is_a?(Array) && body.any? { |d| d.has_key? :search }
+          payload = body
+                    .inject([]) do |sum, item|
+                      meta = item
+                      data = meta.delete(:search)
+
+                      sum << meta
+                      sum << data
+                      sum
+                    end
+                    .map { |item| OpenSearch::API.serializer.dump(item) }
+          payload << "" unless payload.empty?
+          payload = payload.join("\n")
+        when body.is_a?(Array)
+          payload = body.map { |d| d.is_a?(String) ? d : OpenSearch::API.serializer.dump(d) }
+          payload << "" unless payload.empty?
+          payload = payload.join("\n")
+        else
+          payload = body
+        end
+
+        headers.merge!("Content-Type" => "application/x-ndjson")
+        perform_request(method, path, params, payload, headers).body
+      end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:msearch, [
+        :search_type,
+        :max_concurrent_searches,
+        :typed_keys,
+        :pre_filter_shard_size,
+        :max_concurrent_shard_requests,
+        :rest_total_hits_as_int,
+        :ccs_minimize_roundtrips
+      ].freeze)
+    end
+  end
+end

data/lib/opensearch/api/actions/msearch_template.rb

@@ -0,0 +1,96 @@
+# 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 Actions
+      # Allows to execute several search template operations in one request.
+      #
+      # @option arguments [List] :index A comma-separated list of index names to use as default
+      # @option arguments [List] :type A comma-separated list of document types to use as default
+      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
+      # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
+      # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
+      # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
+      # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs), separated by newlines (*Required*)
+      #
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
+      #
+      #
+      #
+      def msearch_template(arguments = {})
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        _type = arguments.delete(:type)
+
+        method = OpenSearch::API::HTTP_POST
+        path   = if _index && _type
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_msearch/template"
+                 elsif _index
+                   "#{Utils.__listify(_index)}/_msearch/template"
+                 else
+                   "_msearch/template"
+                 end
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+        body = arguments[:body]
+        case
+        when body.is_a?(Array)
+          payload = body.map { |d| d.is_a?(String) ? d : OpenSearch::API.serializer.dump(d) }
+          payload << "" unless payload.empty?
+          payload = payload.join("
+")
+        else
+          payload = body
+        end
+
+        headers.merge!("Content-Type" => "application/x-ndjson")
+        perform_request(method, path, params, payload, headers).body
+      end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:msearch_template, [
+        :search_type,
+        :typed_keys,
+        :max_concurrent_searches,
+        :rest_total_hits_as_int,
+        :ccs_minimize_roundtrips
+      ].freeze)
+    end
+  end
+end

data/lib/opensearch/api/actions/mtermvectors.rb

@@ -0,0 +1,107 @@
+# 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 Actions
+      # Returns multiple termvectors in one request.
+      #
+      # @option arguments [String] :index The index in which the document resides.
+      # @option arguments [String] :type The type of the document.
+      # @option arguments [List] :ids A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
+      # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [Boolean] :field_statistics Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [List] :fields A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [Boolean] :offsets Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [Boolean] :positions Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [Boolean] :payloads Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [String] :routing Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs".
+      # @option arguments [Boolean] :realtime Specifies if requests are real-time as opposed to near-real-time (default: true).
+      # @option arguments [Number] :version Explicit version number for concurrency control
+      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
+      #
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
+      #
+      #
+      #
+      def mtermvectors(arguments = {})
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+        ids = arguments.delete(:ids)
+
+        _index = arguments.delete(:index)
+
+        _type = arguments.delete(:type)
+
+        method = if arguments[:body]
+                   OpenSearch::API::HTTP_POST
+                 else
+                   OpenSearch::API::HTTP_GET
+                 end
+
+        path = if _index && _type
+                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_mtermvectors"
+               elsif _index
+                 "#{Utils.__listify(_index)}/_mtermvectors"
+               else
+                 "_mtermvectors"
+               end
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+        if ids
+          body = { :ids => ids }
+        else
+          body = arguments[:body]
+        end
+        perform_request(method, path, params, body, headers).body
+      end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:mtermvectors, [
+        :ids,
+        :term_statistics,
+        :field_statistics,
+        :fields,
+        :offsets,
+        :positions,
+        :payloads,
+        :preference,
+        :routing,
+        :realtime,
+        :version,
+        :version_type
+      ].freeze)
+    end
+  end
+end

data/lib/opensearch/api/actions/nodes/hot_threads.rb

@@ -0,0 +1,81 @@
+# 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 Nodes
+      module Actions
+        # Returns information about hot threads on each node in the cluster.
+        #
+        # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
+        # @option arguments [Time] :interval The interval for the second sampling of threads
+        # @option arguments [Number] :snapshots Number of samples of thread stacktrace (default: 10)
+        # @option arguments [Number] :threads Specify the number of threads to provide information for (default: 3)
+        # @option arguments [Boolean] :ignore_idle_threads Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true)
+        # @option arguments [String] :type The type to sample (default: cpu) (options: cpu, wait, block)
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # *Deprecation notice*:
+        # The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons
+        # Deprecated since version 7.0.0
+        #
+        #
+        #
+        def hot_threads(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          method = OpenSearch::API::HTTP_GET
+          path   = if _node_id
+                     "_cluster/nodes/#{Utils.__listify(_node_id)}/hot_threads"
+                   else
+                     "_cluster/nodes/hot_threads"
+                   end
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+          body = nil
+          perform_request(method, path, params, body, headers).body
+        end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:hot_threads, [
+          :interval,
+          :snapshots,
+          :threads,
+          :ignore_idle_threads,
+          :type,
+          :timeout
+        ].freeze)
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/nodes/info.rb

@@ -0,0 +1,75 @@
+# 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 Nodes
+      module Actions
+        # Returns information about nodes in the cluster.
+        #
+        # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
+        # @option arguments [List] :metric A comma-separated list of metrics you wish returned. Leave empty to return all. (options: settings, os, process, jvm, thread_pool, transport, http, plugins, ingest)
+        # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        #
+        def info(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          _metric = arguments.delete(:metric)
+
+          method = OpenSearch::API::HTTP_GET
+          path   = if _node_id && _metric
+                     "_nodes/#{Utils.__listify(_node_id)}/#{Utils.__listify(_metric)}"
+                   elsif _node_id
+                     "_nodes/#{Utils.__listify(_node_id)}"
+                   elsif _metric
+                     "_nodes/#{Utils.__listify(_metric)}"
+                   else
+                     "_nodes"
+                   end
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+          body = nil
+          perform_request(method, path, params, body, headers).body
+        end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:info, [
+          :flat_settings,
+          :timeout
+        ].freeze)
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/nodes/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 Nodes
+      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/nodes/reload_secure_settings.rb

@@ -0,0 +1,67 @@
+# 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 Nodes
+      module Actions
+        # Reloads secure settings.
+        #
+        # @option arguments [List] :node_id A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body An object containing the password for the opensearch keystore
+        #
+        #
+        def reload_secure_settings(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          method = OpenSearch::API::HTTP_POST
+          path   = if _node_id
+                     "_nodes/#{Utils.__listify(_node_id)}/reload_secure_settings"
+                   else
+                     "_nodes/reload_secure_settings"
+                   end
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+          body = arguments[:body]
+          perform_request(method, path, params, body, headers).body
+        end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:reload_secure_settings, [
+          :timeout
+        ].freeze)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# 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 Nodes
+      module Actions
+        # Shutdown one or all nodes
+        #
+        # @example Shut down node named _Bloke_
+        #
+        #     client.nodes.shutdown node_id: 'Bloke'
+        #
+        # @option arguments [List] :node_id A comma-separated list of node IDs or names to perform the operation on; use
+        #                                   `_local` to shutdown the node you're connected to, leave empty to
+        #                                   shutdown all nodes
+        # @option arguments [Time] :delay Set the delay for the operation (default: 1s)
+        # @option arguments [Boolean] :exit Exit the JVM as well (default: true)
+        #
+        # @see http://opensearch.org/guide/reference/api/admin-cluster-nodes-shutdown/
+        #
+        def shutdown(arguments = {})
+          method = HTTP_POST
+          path   = Utils.__pathify '_cluster/nodes', Utils.__listify(arguments[:node_id]), '_shutdown'
+
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.1.1
+        ParamsRegistry.register(:shutdown, [
+          :delay,
+          :exit
+        ].freeze)
+      end
+    end
+  end
+end