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

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

@@ -3,94 +3,64 @@
 # 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
-    module Actions
-      # Allows to use the Mustache language to pre-render a search definition.
-      #
-      # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
-      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
-      # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
-      # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
-      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
-      # @option arguments [List] :routing A comma-separated list of specific routing values
-      # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
-      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
-      # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
-      # @option arguments [Boolean] :profile Specify whether to profile the query execution
-      # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
-      # @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 search definition template and its params (*Required*)
-      #
-      # *Deprecation notice*:
-      # Specifying types in urls has been deprecated
-      # Deprecated since version 7.0.0
-      #
-      #
-      #
-      def search_template(arguments = {})
-        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+    module Root
+      module Actions
+        # Allows to use the Mustache language to pre-render a search definition.
+        #
+        # @option args [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.
+        # @option args [Boolean] :ccs_minimize_roundtrips (default: true) If `true`, network round-trips are minimized for cross-cluster search requests.
+        # @option args [Enumerable<String>, String] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
+        # @option args [Boolean] :explain If `true`, the response includes additional details about score computation as part of a hit.
+        # @option args [Boolean] :ignore_throttled If `true`, specified concrete, expanded, or aliased indexes are not included in the response when throttled.
+        # @option args [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
+        # @option args [String] :preference (default: random) Specifies the node or shard the operation should be performed on. Random by default.
+        # @option args [Boolean] :profile If `true`, the query execution is profiled.
+        # @option args [Boolean] :rest_total_hits_as_int If `true`, `hits.total` are rendered as an integer in the response.
+        # @option args [Enumerable<String>, String] :routing Custom value used to route operations to a specific shard.
+        # @option args [String] :scroll Specifies how long a consistent view of the index should be maintained for scrolled search.
+        # @option args [String] :search_type The type of the search operation.
+        # @option args [Boolean] :typed_keys If `true`, the response prefixes aggregation and suggester names with their respective types.
+        # @option args [Enumerable<String>, String] :index Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (*).
+        # @option args [Hash] :body *Required* The search definition template and its parameters.
+        def search_template(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
 
-        headers = arguments.delete(:headers) || {}
+          _index = args.delete('index')
 
-        arguments = arguments.clone
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = body ? 'POST' : 'GET'
+          url     = Utils.build_url(_index, '_search/template')
 
-        _index = arguments.delete(:index)
+          Utils.validate_query_params! args, SEARCH_TEMPLATE_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
 
-        method = OpenSearch::API::HTTP_POST
-        path   = if _index
-                   "#{Utils.__listify(_index)}/_search/template"
-                 else
-                   '_search/template'
-                 end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-        body = arguments[:body]
-        perform_request(method, path, params, body, headers).body
+        SEARCH_TEMPLATE_QUERY_PARAMS = Set.new(%w[
+          allow_no_indices
+          ccs_minimize_roundtrips
+          expand_wildcards
+          explain
+          ignore_throttled
+          ignore_unavailable
+          preference
+          profile
+          rest_total_hits_as_int
+          routing
+          scroll
+          search_type
+          typed_keys
+        ]).freeze
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:search_template, %i[
-        ignore_unavailable
-        ignore_throttled
-        allow_no_indices
-        expand_wildcards
-        preference
-        routing
-        scroll
-        search_type
-        explain
-        profile
-        typed_keys
-        rest_total_hits_as_int
-        ccs_minimize_roundtrips
-      ].freeze)
     end
   end
 end

data/lib/opensearch/api/actions/security/authinfo.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 Security
+      module Actions
+        # Returns the authentication information.
+        #
+        # @option args [String] :auth_type The type of current authentication request.
+        # @option args [Boolean] :verbose Indicates whether a verbose response should be returned.
+        def authinfo(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = body ? 'POST' : 'GET'
+          url     = '_plugins/_security/authinfo'
+
+          Utils.validate_query_params! args, AUTHINFO_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        AUTHINFO_QUERY_PARAMS = Set.new(%w[
+          auth_type
+          verbose
+        ]).freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        # Returns the authorization token.
+        #
+        def authtoken(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_security/api/authtoken'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -4,8 +4,8 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-# This code was generated from OpenSearch API Spec.
-# Update the code generation logic instead of modifying this file directly.
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
 # frozen_string_literal: true
 
@@ -13,25 +13,20 @@ module OpenSearch
   module API
     module Security
       module Actions
-        CHANGE_PASSWORD_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Changes the password for the current user.
         #
-        # @option arguments [Hash] :body *Required*
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#change-password]
-        def change_password(arguments = {})
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        # @option args [Hash] :body *Required*
+        def change_password(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
 
-          arguments = arguments.clone
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'account'
-          method  = OpenSearch::API::HTTP_PUT
-          params  = Utils.__validate_and_extract_params arguments, CHANGE_PASSWORD_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = '_plugins/_security/api/account'
 
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
         end
       end
     end

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

@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        # Check whether or not an upgrade can be performed and what resources can be updated.
+        #
+        def config_upgrade_check(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_security/api/_upgrade_check'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        # Helps cluster operator upgrade missing defaults and stale default definitions.
+        #
+        # @option args [Hash] :body
+        def config_upgrade_perform(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_security/api/_upgrade_perform'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -4,8 +4,8 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-# This code was generated from OpenSearch API Spec.
-# Update the code generation logic instead of modifying this file directly.
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
 # frozen_string_literal: true
 
@@ -13,28 +13,24 @@ module OpenSearch
   module API
     module Security
       module Actions
-        CREATE_ACTION_GROUP_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Creates or replaces the specified action group.
         #
-        # @option arguments [String] :action_group *Required* The name of the action group to create or replace
-        # @option arguments [Hash] :body
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#create-action-group]
-        def create_action_group(arguments = {})
-          raise ArgumentError, "Required argument 'action_group' missing" unless arguments[:action_group]
+        # @option args [String] :action_group *Required* The name of the action group to create or replace.
+        # @option args [Hash] :body *Required*
+        def create_action_group(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'action_group' missing" if args['action_group'].nil?
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
 
-          arguments = arguments.clone
-          _action_group = arguments.delete(:action_group)
+          _action_group = args.delete('action_group')
 
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'actiongroups', _action_group
-          method  = OpenSearch::API::HTTP_PUT
-          params  = Utils.__validate_and_extract_params arguments, CREATE_ACTION_GROUP_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = Utils.build_url('_plugins/_security/api/actiongroups', _action_group)
 
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
         end
       end
     end

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

@@ -0,0 +1,34 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        # Creates or replaces the permitted APIs. Accessible using Super Admin certificate or REST API permission.
+        #
+        # @option args [Hash] :body *Required*
+        def create_allowlist(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = '_plugins/_security/api/allowlist'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -4,8 +4,8 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-# This code was generated from OpenSearch API Spec.
-# Update the code generation logic instead of modifying this file directly.
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
 # frozen_string_literal: true
 
@@ -13,29 +13,24 @@ module OpenSearch
   module API
     module Security
       module Actions
-        CREATE_ROLE_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Creates or replaces the specified role.
         #
-        # @option arguments [String] :role *Required*
-        # @option arguments [Hash] :body *Required*
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#create-role]
-        def create_role(arguments = {})
-          raise ArgumentError, "Required argument 'role' missing" unless arguments[:role]
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        # @option args [String] :role *Required* The name of the role to be created.
+        # @option args [Hash] :body *Required*
+        def create_role(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'role' missing" if args['role'].nil?
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
 
-          arguments = arguments.clone
-          _role = arguments.delete(:role)
+          _role = args.delete('role')
 
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'roles', _role
-          method  = OpenSearch::API::HTTP_PUT
-          params  = Utils.__validate_and_extract_params arguments, CREATE_ROLE_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = Utils.build_url('_plugins/_security/api/roles', _role)
 
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
         end
       end
     end

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

@@ -4,8 +4,8 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-# This code was generated from OpenSearch API Spec.
-# Update the code generation logic instead of modifying this file directly.
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
 # frozen_string_literal: true
 
@@ -13,29 +13,24 @@ module OpenSearch
   module API
     module Security
       module Actions
-        CREATE_ROLE_MAPPING_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Creates or replaces the specified role mapping.
         #
-        # @option arguments [String] :role *Required*
-        # @option arguments [Hash] :body *Required*
-        #
-        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping]
-        def create_role_mapping(arguments = {})
-          raise ArgumentError, "Required argument 'role' missing" unless arguments[:role]
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        # @option args [String] :role *Required* The name of the role to create a role mapping for.
+        # @option args [Hash] :body *Required*
+        def create_role_mapping(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'role' missing" if args['role'].nil?
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
 
-          arguments = arguments.clone
-          _role = arguments.delete(:role)
+          _role = args.delete('role')
 
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'rolesmapping', _role
-          method  = OpenSearch::API::HTTP_PUT
-          params  = Utils.__validate_and_extract_params arguments, CREATE_ROLE_MAPPING_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = Utils.build_url('_plugins/_security/api/rolesmapping', _role)
 
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
         end
       end
     end

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

@@ -4,8 +4,8 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-# This code was generated from OpenSearch API Spec.
-# Update the code generation logic instead of modifying this file directly.
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
 # frozen_string_literal: true
 
@@ -13,28 +13,24 @@ module OpenSearch
   module API
     module Security
       module Actions
-        CREATE_TENANT_QUERY_PARAMS = Set.new(%i[
-        ]).freeze
-
         # Creates or replaces the specified tenant.
         #
-        # @option arguments [String] :tenant *Required*
-        # @option arguments [Hash] :body
-        #
-        # {API Reference}[https://opensearch.org/docs/2.7/security/access-control/api/#create-tenant]
-        def create_tenant(arguments = {})
-          raise ArgumentError, "Required argument 'tenant' missing" unless arguments[:tenant]
+        # @option args [String] :tenant *Required* The name of the tenant to be created.
+        # @option args [Hash] :body *Required*
+        def create_tenant(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'tenant' missing" if args['tenant'].nil?
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
 
-          arguments = arguments.clone
-          _tenant = arguments.delete(:tenant)
+          _tenant = args.delete('tenant')
 
-          headers = arguments.delete(:headers) || {}
-          body    = arguments.delete(:body)
-          url     = Utils.__pathify '_plugins', '_security', 'api', 'tenants', _tenant
-          method  = OpenSearch::API::HTTP_PUT
-          params  = Utils.__validate_and_extract_params arguments, CREATE_TENANT_QUERY_PARAMS
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = Utils.build_url('_plugins/_security/api/tenants', _tenant)
 
-          perform_request(method, url, params, body, headers).body
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
         end
       end
     end

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

@@ -0,0 +1,34 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        # Creates or replaces the multi-tenancy configuration. Only accessible to admins and users with REST API permissions.
+        #
+        # @option args [Hash] :body *Required*
+        def create_update_tenancy_config(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = '_plugins/_security/api/tenancy/config'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end