# Added Utils.build_url and renamed others.

Signed-off-by: Theo Truong <theotr@amazon.com>
opensearch-project · Dec 20, 2024 · a3ec626 · a3ec626
1 parent e140e97
commit a3ec626
Show file tree

Hide file tree

Showing 365 changed files with 736 additions and 736 deletions.
diff --git a/api_generator/lib/components/api_path.rb b/api_generator/lib/components/api_path.rb
@@ -14,7 +14,7 @@ def initialize(url)
 
   def build
     return "'/'" if components.empty?
-    return components.join('/') if components.none? { |comp| comp.start_with?('_') }
+    return components.first if components.size == 1
     "Utils.build_url(#{components.join(', ')})"
   end
 

diff --git a/api_generator/lib/templates/action.mustache b/api_generator/lib/templates/action.mustache
@@ -20,7 +20,7 @@ module OpenSearch
         # {API Reference}[{{{api_reference}}}]
         {{/api_reference}}
         def {{method_name}}(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           {{#required_args}}
           raise ArgumentError, "Required argument '{{arg}}' missing" if args['{{arg}}'].nil?
           {{#_blank_line}}
@@ -47,7 +47,7 @@ module OpenSearch
           method  = {{{http_verb}}}
           url     = {{{url}}}
 
-          Utils.validate_query_params args{{#has_query}}, {{valid_params_constant_name}}{{/has_query}}
+          Utils.validate_query_params! args{{#has_query}}, {{valid_params_constant_name}}{{/has_query}}
           {{{perform_request}}}
         end
         {{#has_query}}

diff --git a/lib/opensearch/api/actions/asynchronous_search/delete.rb b/lib/opensearch/api/actions/asynchronous_search/delete.rb
@@ -18,7 +18,7 @@ module Actions
         # @option args [String] :id *Required*
         # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
         def delete(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
 
           _id = args.delete('id')
@@ -29,7 +29,7 @@ def delete(args = {})
           method  = 'DELETE'
           url     = Utils.build_url('_plugins/_asynchronous_search', _id)
 
-          Utils.validate_query_params args
+          Utils.validate_query_params! args
           transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
         end
       end

diff --git a/lib/opensearch/api/actions/asynchronous_search/get.rb b/lib/opensearch/api/actions/asynchronous_search/get.rb
@@ -17,7 +17,7 @@ module Actions
         #
         # @option args [String] :id *Required*
         def get(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
 
           _id = args.delete('id')
@@ -27,7 +27,7 @@ def get(args = {})
           method  = 'GET'
           url     = Utils.build_url('_plugins/_asynchronous_search', _id)
 
-          Utils.validate_query_params args
+          Utils.validate_query_params! args
           transport.perform_request(method, url, args, body, headers).body
         end
       end

diff --git a/lib/opensearch/api/actions/asynchronous_search/search.rb b/lib/opensearch/api/actions/asynchronous_search/search.rb
@@ -21,13 +21,13 @@ module Actions
         # @option args [String] :wait_for_completion_timeout The amount of time that you plan to wait for the results. You can poll the remaining results based on an ID. The maximum value is `300s`. Default is `1s`.
         # @option args [Hash] :body The search definition using the Query DSL.
         def search(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'POST'
           url     = '_plugins/_asynchronous_search'
 
-          Utils.validate_query_params args, SEARCH_QUERY_PARAMS
+          Utils.validate_query_params! args, SEARCH_QUERY_PARAMS
           transport.perform_request(method, url, args, body, headers).body
         end
 

diff --git a/lib/opensearch/api/actions/asynchronous_search/stats.rb b/lib/opensearch/api/actions/asynchronous_search/stats.rb
@@ -16,13 +16,13 @@ module Actions
         # Monitoring of asynchronous searches that are running, completed, and/or persisted.
         #
         def stats(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'GET'
           url     = '_plugins/_asynchronous_search/stats'
 
-          Utils.validate_query_params args
+          Utils.validate_query_params! args
           transport.perform_request(method, url, args, body, headers).body
         end
       end

diff --git a/lib/opensearch/api/actions/bulk.rb b/lib/opensearch/api/actions/bulk.rb
@@ -28,7 +28,7 @@ module Actions
         # @option args [String] :index Name of the data stream, index, or index alias to perform bulk actions on.
         # @option args [Enumerable<Hash>] :body *Required* The operation definition and data (action-data pairs), separated by newlines
         def bulk(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
 
           _index = args.delete('index')
@@ -38,7 +38,7 @@ def bulk(args = {})
           method  = _index.nil? ? 'POST' : 'PUT'
           url     = Utils.build_url(_index, '_bulk')
 
-          Utils.validate_query_params args, BULK_QUERY_PARAMS
+          Utils.validate_query_params! args, BULK_QUERY_PARAMS
           transport.perform_request(method, url, args, body, headers).body
         end
 

diff --git a/lib/opensearch/api/actions/bulk_stream.rb b/lib/opensearch/api/actions/bulk_stream.rb
@@ -30,7 +30,7 @@ module Actions
         # @option args [String] :index Name of the data stream, index, or index alias to perform bulk actions on.
         # @option args [Enumerable<Hash>] :body *Required* The operation definition and data (action-data pairs), separated by newlines
         def bulk_stream(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
 
           _index = args.delete('index')
@@ -40,7 +40,7 @@ def bulk_stream(args = {})
           method  = _index.nil? ? 'POST' : 'PUT'
           url     = Utils.build_url(_index, '_bulk/stream')
 
-          Utils.validate_query_params args, BULK_STREAM_QUERY_PARAMS
+          Utils.validate_query_params! args, BULK_STREAM_QUERY_PARAMS
           transport.perform_request(method, url, args, body, headers).body
         end
 

diff --git a/lib/opensearch/api/actions/cat/aliases.rb b/lib/opensearch/api/actions/cat/aliases.rb
@@ -24,15 +24,15 @@ module Actions
         # @option args [Boolean] :v Verbose mode. Display column headers.
         # @option args [Enumerable<String>, String] :name A comma-separated list of aliases to retrieve. Supports wildcards (`*`).  To retrieve all aliases, omit this parameter or use `*` or `_all`.
         def aliases(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           _name = args.delete('name')
 
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'GET'
           url     = Utils.build_url('_cat/aliases', _name)
 
-          Utils.validate_query_params args, ALIASES_QUERY_PARAMS
+          Utils.validate_query_params! args, ALIASES_QUERY_PARAMS
           transport.perform_request(method, url, args, body, headers).body
         end
 

diff --git a/lib/opensearch/api/actions/cat/all_pit_segments.rb b/lib/opensearch/api/actions/cat/all_pit_segments.rb
@@ -22,13 +22,13 @@ module Actions
         # @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 all_pit_segments(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'GET'
           url     = '_cat/pit_segments/_all'
 
-          Utils.validate_query_params args, ALL_PIT_SEGMENTS_QUERY_PARAMS
+          Utils.validate_query_params! args, ALL_PIT_SEGMENTS_QUERY_PARAMS
           transport.perform_request(method, url, args, body, headers).body
         end
 

diff --git a/lib/opensearch/api/actions/cat/allocation.rb b/lib/opensearch/api/actions/cat/allocation.rb
@@ -26,15 +26,15 @@ module Actions
         # @option args [Boolean] :v Verbose mode. Display column headers.
         # @option args [Enumerable<String>, String] :node_id Comma-separated list of node identifiers or names used to limit the returned information.
         def allocation(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           _node_id = args.delete('node_id')
 
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'GET'
           url     = Utils.build_url('_cat/allocation', _node_id)
 
-          Utils.validate_query_params args, ALLOCATION_QUERY_PARAMS
+          Utils.validate_query_params! args, ALLOCATION_QUERY_PARAMS
           transport.perform_request(method, url, args, body, headers).body
         end
 

diff --git a/lib/opensearch/api/actions/cat/cluster_manager.rb b/lib/opensearch/api/actions/cat/cluster_manager.rb
@@ -24,13 +24,13 @@ module Actions
         # @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 cluster_manager(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'GET'
           url     = '_cat/cluster_manager'
 
-          Utils.validate_query_params args, CLUSTER_MANAGER_QUERY_PARAMS
+          Utils.validate_query_params! args, CLUSTER_MANAGER_QUERY_PARAMS
           transport.perform_request(method, url, args, body, headers).body
         end
 

diff --git a/lib/opensearch/api/actions/cat/count.rb b/lib/opensearch/api/actions/cat/count.rb
@@ -22,15 +22,15 @@ module Actions
         # @option args [Boolean] :v Verbose mode. Display column headers.
         # @option args [Enumerable<String>, String] :index 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 count(args = {})
-          args = Utils.normalize_arguments(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/count', _index)
 
-          Utils.validate_query_params args, COUNT_QUERY_PARAMS
+          Utils.validate_query_params! args, COUNT_QUERY_PARAMS
           transport.perform_request(method, url, args, body, headers).body
         end
 

diff --git a/lib/opensearch/api/actions/cat/fielddata.rb b/lib/opensearch/api/actions/cat/fielddata.rb
@@ -23,15 +23,15 @@ module Actions
         # @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 fielddata(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           _fields = args.delete('fields')
 
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'GET'
           url     = Utils.build_url('_cat/fielddata', _fields)
 
-          Utils.validate_query_params args, FIELDDATA_QUERY_PARAMS
+          Utils.validate_query_params! args, FIELDDATA_QUERY_PARAMS
           transport.perform_request(method, url, args, body, headers).body
         end
 

diff --git a/lib/opensearch/api/actions/cat/health.rb b/lib/opensearch/api/actions/cat/health.rb
@@ -23,13 +23,13 @@ module Actions
         # @option args [Boolean] :ts (default: true) If `true`, returns `HH:MM:SS` and Unix epoch timestamps.
         # @option args [Boolean] :v Verbose mode. Display column headers.
         def health(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'GET'
           url     = '_cat/health'
 
-          Utils.validate_query_params args, HEALTH_QUERY_PARAMS
+          Utils.validate_query_params! args, HEALTH_QUERY_PARAMS
           transport.perform_request(method, url, args, body, headers).body
         end
 

diff --git a/lib/opensearch/api/actions/cat/help.rb b/lib/opensearch/api/actions/cat/help.rb
@@ -16,13 +16,13 @@ module Actions
         # Returns help for the Cat APIs.
         #
         def help(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'GET'
           url     = '_cat'
 
-          Utils.validate_query_params args
+          Utils.validate_query_params! args
           transport.perform_request(method, url, args, body, headers).body
         end
       end

diff --git a/lib/opensearch/api/actions/cat/indices.rb b/lib/opensearch/api/actions/cat/indices.rb
@@ -31,15 +31,15 @@ module Actions
         # @option args [Boolean] :v Verbose mode. Display column headers.
         # @option args [Enumerable<String>, String] :index 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 indices(args = {})
-          args = Utils.normalize_arguments(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/indices', _index)
 
-          Utils.validate_query_params args, INDICES_QUERY_PARAMS
+          Utils.validate_query_params! args, INDICES_QUERY_PARAMS
           transport.perform_request(method, url, args, body, headers).body
         end
 

diff --git a/lib/opensearch/api/actions/cat/master.rb b/lib/opensearch/api/actions/cat/master.rb
@@ -24,13 +24,13 @@ module Actions
         # @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 master(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'GET'
           url     = '_cat/master'
 
-          Utils.validate_query_params args, MASTER_QUERY_PARAMS
+          Utils.validate_query_params! args, MASTER_QUERY_PARAMS
           transport.perform_request(method, url, args, body, headers).body
         end
 

diff --git a/lib/opensearch/api/actions/cat/nodeattrs.rb b/lib/opensearch/api/actions/cat/nodeattrs.rb
@@ -24,13 +24,13 @@ module Actions
         # @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 nodeattrs(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'GET'
           url     = '_cat/nodeattrs'
 
-          Utils.validate_query_params args, NODEATTRS_QUERY_PARAMS
+          Utils.validate_query_params! args, NODEATTRS_QUERY_PARAMS
           transport.perform_request(method, url, args, body, headers).body
         end
 

diff --git a/lib/opensearch/api/actions/cat/nodes.rb b/lib/opensearch/api/actions/cat/nodes.rb
@@ -27,13 +27,13 @@ module Actions
         # @option args [String] :time The unit in which to display time values.
         # @option args [Boolean] :v Verbose mode. Display column headers.
         def nodes(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'GET'
           url     = '_cat/nodes'
 
-          Utils.validate_query_params args, NODES_QUERY_PARAMS
+          Utils.validate_query_params! args, NODES_QUERY_PARAMS
           transport.perform_request(method, url, args, body, headers).body
         end
 

diff --git a/lib/opensearch/api/actions/cat/pending_tasks.rb b/lib/opensearch/api/actions/cat/pending_tasks.rb
@@ -25,13 +25,13 @@ module Actions
         # @option args [String] :time The unit in which to display time values.
         # @option args [Boolean] :v Verbose mode. Display column headers.
         def pending_tasks(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'GET'
           url     = '_cat/pending_tasks'
 
-          Utils.validate_query_params args, PENDING_TASKS_QUERY_PARAMS
+          Utils.validate_query_params! args, PENDING_TASKS_QUERY_PARAMS
           transport.perform_request(method, url, args, body, headers).body
         end
 

diff --git a/lib/opensearch/api/actions/cat/pit_segments.rb b/lib/opensearch/api/actions/cat/pit_segments.rb
@@ -23,13 +23,13 @@ module Actions
         # @option args [Boolean] :v Verbose mode. Display column headers.
         # @option args [Hash] :body
         def pit_segments(args = {})
-          args = Utils.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'GET'
           url     = '_cat/pit_segments'
 
-          Utils.validate_query_params args, PIT_SEGMENTS_QUERY_PARAMS
+          Utils.validate_query_params! args, PIT_SEGMENTS_QUERY_PARAMS
           transport.perform_request(method, url, args, body, headers).body
         end
 

diff --git a/lib/opensearch/api/actions/cat/plugins.rb b/lib/opensearch/api/actions/cat/plugins.rb
@@ -24,13 +24,13 @@ module Actions
         # @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.normalize_arguments(args)
+          args = Utils.clone_and_normalize_arguments(args)
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'GET'
           url     = '_cat/plugins'
 
-          Utils.validate_query_params args, PLUGINS_QUERY_PARAMS
+          Utils.validate_query_params! args, PLUGINS_QUERY_PARAMS
           transport.perform_request(method, url, args, body, headers).body
         end
 

diff --git a/lib/opensearch/api/actions/cat/recovery.rb b/lib/opensearch/api/actions/cat/recovery.rb
@@ -26,15 +26,15 @@ module Actions
         # @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.normalize_arguments(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/recovery', _index)
 
-          Utils.validate_query_params args, RECOVERY_QUERY_PARAMS
+          Utils.validate_query_params! args, RECOVERY_QUERY_PARAMS
           transport.perform_request(method, url, args, body, headers).body
         end