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

data/lib/opensearch/api/actions/cat/plugins.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,45 +15,35 @@ module OpenSearch
       module Actions
         # Returns information about installed plugins across nodes node.
         #
-        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
-        # @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 [List] :h Comma-separated list of column names to display
-        # @option arguments [Boolean] :help Return help information
-        # @option arguments [Boolean] :include_bootstrap Include bootstrap plugins in the response
-        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
-        # @option arguments [Boolean] :v Verbose mode. Display column headers
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def plugins(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Enumerable<String>] :h Comma-separated list of column names to display.
+        # @option args [Boolean] :help Return help information.
+        # @option args [Boolean] :local Return local information, do not retrieve the state from cluster-manager node.
+        # @option args [String] :master_timeout DEPRECATED Operation timeout for connection to cluster-manager node.
+        # @option args [Enumerable<String>] :s Comma-separated list of column names or column aliases to sort by.
+        # @option args [Boolean] :v Verbose mode. Display column headers.
+        def plugins(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_cat/plugins'
 
-          method = OpenSearch::API::HTTP_GET
-          path   = '_cat/plugins'
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, PLUGINS_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(:plugins, %i[
-          format
-          local
-          master_timeout
+        PLUGINS_QUERY_PARAMS = Set.new(%w[
           cluster_manager_timeout
+          format
           h
           help
-          include_bootstrap
+          local
+          master_timeout
           s
           v
-        ].freeze)
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/cat/recovery.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,54 +15,40 @@ module OpenSearch
       module Actions
         # Returns information about index shard recoveries, both on-going completed.
         #
-        # @option arguments [List] :index Comma-separated list or wildcard expression of index names to limit the returned information
-        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
-        # @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
-        # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries
-        # @option arguments [List] :h Comma-separated list of column names to display
-        # @option arguments [Boolean] :help Return help information
-        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
-        # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
-        # @option arguments [Boolean] :v Verbose mode. Display column headers
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def recovery(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _index = arguments.delete(:index)
+        # @option args [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries.
+        # @option args [String] :bytes The unit used to display byte values.
+        # @option args [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Enumerable<String>] :h Comma-separated list of column names to display.
+        # @option args [Boolean] :help Return help information.
+        # @option args [Enumerable<String>] :index Comma-separated list or wildcard expression of index names to limit the returned information.
+        # @option args [Enumerable<String>] :s Comma-separated list of column names or column aliases to sort by.
+        # @option args [String] :time The unit in which to display time values.
+        # @option args [Boolean] :v Verbose mode. Display column headers.
+        def recovery(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _index = args.delete('index')
 
-          method = OpenSearch::API::HTTP_GET
-          path   = if _index
-                     "_cat/recovery/#{Utils.__listify(_index)}"
-                   else
-                     '_cat/recovery'
-                   end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          params[:h] = Utils.__listify(params[:h]) if params[:h]
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_cat/recovery', _index)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, RECOVERY_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(:recovery, %i[
-          format
+        RECOVERY_QUERY_PARAMS = Set.new(%w[
           active_only
           bytes
           detailed
+          format
           h
           help
-          index
           s
           time
           v
-        ].freeze)
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/cat/repositories.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,35 @@ module OpenSearch
       module Actions
         # Returns information about snapshot repositories registered in the cluster.
         #
-        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node
-        # @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 [List] :h Comma-separated list of column names to display
-        # @option arguments [Boolean] :help Return help information
-        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
-        # @option arguments [Boolean] :v Verbose mode. Display column headers
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def repositories(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Enumerable<String>] :h Comma-separated list of column names to display.
+        # @option args [Boolean] :help Return help information.
+        # @option args [Boolean] :local Return local information, do not retrieve the state from cluster-manager node.
+        # @option args [String] :master_timeout DEPRECATED Operation timeout for connection to cluster-manager node.
+        # @option args [Enumerable<String>] :s Comma-separated list of column names or column aliases to sort by.
+        # @option args [Boolean] :v Verbose mode. Display column headers.
+        def repositories(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_cat/repositories'
 
-          method = OpenSearch::API::HTTP_GET
-          path   = '_cat/repositories'
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, REPOSITORIES_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(:repositories, %i[
-          format
-          local
-          master_timeout
+        REPOSITORIES_QUERY_PARAMS = Set.new(%w[
           cluster_manager_timeout
+          format
           h
           help
+          local
+          master_timeout
           s
           v
-        ].freeze)
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/cat/segment_replication.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.
+
+# 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 Cat
+      module Actions
+        # Returns information about both on-going and latest completed Segment Replication events.
+        #
+        # @option args [Boolean] :active_only If `true`, the response only includes ongoing segment replication events.
+        # @option args [Boolean] :allow_no_indices Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified).
+        # @option args [String] :bytes The unit in which to display byte values.
+        # @option args [Boolean] :completed_only If `true`, the response only includes latest completed segment replication events.
+        # @option args [Boolean] :detailed If `true`, the response includes detailed information about segment replications.
+        # @option args [Enumerable<String>, String] :expand_wildcards Whether to expand wildcard expression to concrete indexes that are open, closed or both.
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Enumerable<String>] :h Comma-separated list of column names to display.
+        # @option args [Boolean] :help Return help information.
+        # @option args [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indexes should be ignored when throttled.
+        # @option args [Boolean] :ignore_unavailable Whether specified concrete indexes should be ignored when unavailable (missing or closed).
+        # @option args [Enumerable<String>] :index Comma-separated list or wildcard expression of index names to limit the returned information.
+        # @option args [Enumerable<String>] :s Comma-separated list of column names or column aliases to sort by.
+        # @option args [Enumerable<String>] :shards Comma-separated list of shards to display.
+        # @option args [String] :time The unit in which to display time values.
+        # @option args [String] :timeout Operation timeout.
+        # @option args [Boolean] :v Verbose mode. Display column headers.
+        def segment_replication(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _index = args.delete('index')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_cat/segment_replication', _index)
+
+          Utils.validate_query_params! args, SEGMENT_REPLICATION_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        SEGMENT_REPLICATION_QUERY_PARAMS = Set.new(%w[
+          active_only
+          allow_no_indices
+          bytes
+          completed_only
+          detailed
+          expand_wildcards
+          format
+          h
+          help
+          ignore_throttled
+          ignore_unavailable
+          s
+          shards
+          time
+          timeout
+          v
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/cat/segments.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,46 +15,38 @@ module OpenSearch
       module Actions
         # Provides low-level information about the segments in the shards of an index.
         #
-        # @option arguments [List] :index A comma-separated list of index names to limit the returned information
-        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
-        # @option arguments [List] :h Comma-separated list of column names to display
-        # @option arguments [Boolean] :help Return help information
-        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
-        # @option arguments [Boolean] :v Verbose mode. Display column headers
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def segments(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _index = arguments.delete(:index)
+        # @option args [String] :bytes The unit used to display byte values.
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Enumerable<String>] :h Comma-separated list of column names to display.
+        # @option args [Boolean] :help Return help information.
+        # @option args [String] :master_timeout DEPRECATED Operation timeout for connection to cluster-manager node.
+        # @option args [Enumerable<String>] :s Comma-separated list of column names or column aliases to sort by.
+        # @option args [Boolean] :v Verbose mode. Display column headers.
+        # @option args [Enumerable<String>, String] :index A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`.
+        def segments(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _index = args.delete('index')
 
-          method = OpenSearch::API::HTTP_GET
-          path   = if _index
-                     "_cat/segments/#{Utils.__listify(_index)}"
-                   else
-                     '_cat/segments'
-                   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('_cat/segments', _index)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, SEGMENTS_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(:segments, %i[
-          format
+        SEGMENTS_QUERY_PARAMS = Set.new(%w[
           bytes
+          cluster_manager_timeout
+          format
           h
           help
+          master_timeout
           s
           v
-        ].freeze)
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/cat/shards.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,55 +15,42 @@ module OpenSearch
       module Actions
         # Provides a detailed view of shard allocation on nodes.
         #
-        # @option arguments [List] :index A comma-separated list of index names to limit the returned information
-        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
-        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) *Deprecated*
-        # @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 [List] :h Comma-separated list of column names to display
-        # @option arguments [Boolean] :help Return help information
-        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
-        # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
-        # @option arguments [Boolean] :v Verbose mode. Display column headers
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def shards(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
+        # @option args [String] :bytes The unit used to display byte values.
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Enumerable<String>] :h Comma-separated list of column names to display.
+        # @option args [Boolean] :help Return help information.
+        # @option args [Boolean] :local Return local information, do not retrieve the state from cluster-manager node.
+        # @option args [String] :master_timeout DEPRECATED Operation timeout for connection to cluster-manager node.
+        # @option args [Enumerable<String>] :s Comma-separated list of column names or column aliases to sort by.
+        # @option args [String] :time The unit in which to display time values.
+        # @option args [Boolean] :v Verbose mode. Display column headers.
+        # @option args [Enumerable<String>, String] :index A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`.
+        def shards(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _index = args.delete('index')
 
-          _index = arguments.delete(:index)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_cat/shards', _index)
 
-          method = OpenSearch::API::HTTP_GET
-          path   = if _index
-                     "_cat/shards/#{Utils.__listify(_index)}"
-                   else
-                     '_cat/shards'
-                   end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          params[:h] = Utils.__listify(params[:h]) if params[:h]
-
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, SHARDS_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(:shards, %i[
-          format
+        SHARDS_QUERY_PARAMS = Set.new(%w[
           bytes
-          local
-          master_timeout
           cluster_manager_timeout
+          format
           h
           help
+          local
+          master_timeout
           s
           time
           v
-        ].freeze)
+        ]).freeze
       end
     end
   end