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

data/lib/opensearch/api/actions/snapshot/get.rb

@@ -3,26 +3,11 @@
 # 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.
+
+# 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
@@ -30,52 +15,35 @@ module OpenSearch
       module Actions
         # Returns information about a snapshot.
         #
-        # @option arguments [String] :repository A repository name
-        # @option arguments [List] :snapshot A comma-separated list of snapshot names
-        # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
-        # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
-        # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
-        # @option arguments [Boolean] :index_details Whether to include details of each index in the snapshot, if those details are available. Defaults to false.
-        # @option arguments [Boolean] :include_repository Whether to include the repository name in the snapshot info. Defaults to true.
-        # @option arguments [Boolean] :verbose Whether to show verbose snapshot info or only show the basic info found in the repository index blob
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def get(arguments = {})
-          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-          raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
-
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _repository = arguments.delete(:repository)
-
-          _snapshot = arguments.delete(:snapshot)
-
-          method = OpenSearch::API::HTTP_GET
-          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
-          if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
-          else
-            perform_request(method, path, params, body, headers).body
-          end
+        # @option args [String] :repository *Required* Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported.
+        # @option args [Enumerable<String>, String] :snapshot *Required* Comma-separated list of snapshot names to retrieve. Also accepts wildcards (`*`). - To get information about all snapshots in a registered repository, use a wildcard (`*`) or `_all`. - To get information about any snapshots that are currently running, use `_current`.
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [Boolean] :ignore_unavailable If `false`, the request returns an error for any snapshots that are unavailable.
+        # @option args [String] :master_timeout DEPRECATED Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.
+        # @option args [Boolean] :verbose If `true`, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.
+        def get(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'repository' missing" if args['repository'].nil?
+          raise ArgumentError, "Required argument 'snapshot' missing" if args['snapshot'].nil?
+
+          _repository = args.delete('repository')
+          _snapshot = args.delete('snapshot')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_snapshot', _repository, _snapshot)
+
+          Utils.validate_query_params! args, GET_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:get, %i[
-          master_timeout
+        GET_QUERY_PARAMS = Set.new(%w[
           cluster_manager_timeout
           ignore_unavailable
-          index_details
-          include_repository
+          master_timeout
           verbose
-        ].freeze)
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/snapshot/get_repository.rb

@@ -3,26 +3,11 @@
 # 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.
+
+# 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
@@ -30,43 +15,28 @@ module OpenSearch
       module Actions
         # Returns information about a repository.
         #
-        # @option arguments [List] :repository A comma-separated list of repository names
-        # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to cluster_manager node
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def get_repository(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _repository = arguments.delete(:repository)
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [Boolean] :local Return local information, do not retrieve the state from cluster-manager node.
+        # @option args [String] :master_timeout DEPRECATED Explicit operation timeout for connection to cluster-manager node
+        # @option args [Enumerable<String>, String] :repository A comma-separated list of repository names
+        def get_repository(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _repository = args.delete('repository')
 
-          method = OpenSearch::API::HTTP_GET
-          path   = if _repository
-                     "_snapshot/#{Utils.__listify(_repository)}"
-                   else
-                     '_snapshot'
-                   end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_snapshot', _repository)
 
-          body = nil
-          if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
-          else
-            perform_request(method, path, params, body, headers).body
-          end
+          Utils.validate_query_params! args, GET_REPOSITORY_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:get_repository, %i[
-          master_timeout
+        GET_REPOSITORY_QUERY_PARAMS = Set.new(%w[
           cluster_manager_timeout
           local
-        ].freeze)
+          master_timeout
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/snapshot/restore.rb

@@ -3,26 +3,11 @@
 # 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.
+
+# 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
@@ -30,43 +15,34 @@ module OpenSearch
       module Actions
         # Restores a snapshot.
         #
-        # @option arguments [String] :repository A repository name
-        # @option arguments [String] :snapshot A snapshot name
-        # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
-        # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
-        # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
-        # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body Details of what to restore
-        #
-        #
-        def restore(arguments = {})
-          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-          raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
-
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _repository = arguments.delete(:repository)
-
-          _snapshot = arguments.delete(:snapshot)
-
-          method = OpenSearch::API::HTTP_POST
-          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_restore"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = arguments[:body]
-          perform_request(method, path, params, body, headers).body
+        # @option args [String] :repository *Required* A repository name
+        # @option args [String] :snapshot *Required* A snapshot name
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :master_timeout DEPRECATED Explicit operation timeout for connection to cluster-manager node
+        # @option args [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
+        # @option args [Hash] :body Details of what to restore
+        def restore(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'repository' missing" if args['repository'].nil?
+          raise ArgumentError, "Required argument 'snapshot' missing" if args['snapshot'].nil?
+
+          _repository = args.delete('repository')
+          _snapshot = args.delete('snapshot')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_snapshot', _repository, _snapshot, '_restore')
+
+          Utils.validate_query_params! args, RESTORE_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:restore, %i[
-          master_timeout
+        RESTORE_QUERY_PARAMS = Set.new(%w[
           cluster_manager_timeout
+          master_timeout
           wait_for_completion
-        ].freeze)
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/snapshot/status.rb

@@ -3,26 +3,11 @@
 # 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.
+
+# 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
@@ -30,49 +15,30 @@ module OpenSearch
       module Actions
         # Returns information about the status of a snapshot.
         #
-        # @option arguments [String] :repository A repository name
-        # @option arguments [List] :snapshot A comma-separated list of snapshot names
-        # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
-        # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
-        # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def status(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _repository = arguments.delete(:repository)
-
-          _snapshot = arguments.delete(:snapshot)
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to `false` which means a SnapshotMissingException is thrown
+        # @option args [String] :master_timeout DEPRECATED Explicit operation timeout for connection to cluster-manager node
+        # @option args [String] :repository A repository name
+        # @option args [Enumerable<String>, String] :snapshot A comma-separated list of snapshot names
+        def status(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _repository = args.delete('repository')
+          _snapshot = args.delete('snapshot')
 
-          method = OpenSearch::API::HTTP_GET
-          path   = if _repository && _snapshot
-                     "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_status"
-                   elsif _repository
-                     "_snapshot/#{Utils.__listify(_repository)}/_status"
-                   else
-                     '_snapshot/_status'
-                   end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_snapshot', _repository, _snapshot, '_status')
 
-          body = nil
-          if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
-          else
-            perform_request(method, path, params, body, headers).body
-          end
+          Utils.validate_query_params! args, STATUS_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:status, %i[
-          master_timeout
+        STATUS_QUERY_PARAMS = Set.new(%w[
           cluster_manager_timeout
           ignore_unavailable
-        ].freeze)
+          master_timeout
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/snapshot/verify_repository.rb

@@ -3,26 +3,11 @@
 # 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.
+
+# 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
@@ -30,38 +15,30 @@ module OpenSearch
       module Actions
         # Verifies a repository.
         #
-        # @option arguments [String] :repository A repository name
-        # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
-        # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def verify_repository(arguments = {})
-          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
+        # @option args [String] :repository *Required* A repository name
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :master_timeout DEPRECATED Explicit operation timeout for connection to cluster-manager node
+        # @option args [String] :timeout Explicit operation timeout
+        def verify_repository(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'repository' missing" if args['repository'].nil?
 
-          _repository = arguments.delete(:repository)
+          _repository = args.delete('repository')
 
-          method = OpenSearch::API::HTTP_POST
-          path   = "_snapshot/#{Utils.__listify(_repository)}/_verify"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_snapshot', _repository, '_verify')
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, VERIFY_REPOSITORY_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:verify_repository, %i[
-          master_timeout
+        VERIFY_REPOSITORY_QUERY_PARAMS = Set.new(%w[
           cluster_manager_timeout
+          master_timeout
           timeout
-        ].freeze)
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/sql/close.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 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 Sql
+      module Actions
+        # Clear the cursor context.
+        #
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Boolean] :sanitize (default: true) Specifies whether to escape special characters in the results
+        # @option args [Hash] :body
+        def close(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_sql/close'
+
+          Utils.validate_query_params! args, CLOSE_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        CLOSE_QUERY_PARAMS = Set.new(%w[
+          format
+          sanitize
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/sql/explain.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 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 Sql
+      module Actions
+        # Shows how a query is executed against OpenSearch.
+        #
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Boolean] :sanitize (default: true) Specifies whether to escape special characters in the results
+        # @option args [Hash] :body
+        def explain(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_sql/_explain'
+
+          Utils.validate_query_params! args, EXPLAIN_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        EXPLAIN_QUERY_PARAMS = Set.new(%w[
+          format
+          sanitize
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/sql/get_stats.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 Sql
+      module Actions
+        # Collect metrics for the plugin within the interval.
+        #
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Boolean] :sanitize (default: true) Specifies whether to escape special characters in the results
+        def get_stats(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_sql/stats'
+
+          Utils.validate_query_params! args, GET_STATS_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        GET_STATS_QUERY_PARAMS = Set.new(%w[
+          format
+          sanitize
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/sql/post_stats.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 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 Sql
+      module Actions
+        # By a stats endpoint, you are able to collect metrics for the plugin within the interval.
+        #
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Boolean] :sanitize (default: true) Specifies whether to escape special characters in the results
+        # @option args [Hash] :body
+        def post_stats(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_sql/stats'
+
+          Utils.validate_query_params! args, POST_STATS_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        POST_STATS_QUERY_PARAMS = Set.new(%w[
+          format
+          sanitize
+        ]).freeze
+      end
+    end
+  end
+end