lib/elasticsearch/api/actions/search_template.rb in elasticsearch-api-6.2.0 vs lib/elasticsearch/api/actions/search_template.rb in elasticsearch-api-6.3.0

@@ -16,29 +16,25 @@
       #                                }
       #                              },
       #                              params: { start: "2014-02-01", end: "2014-03-01" }
       #                            }
       #
-      # @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 [List] :type A comma-separated list of document types to search;
-      #                                leave empty to perform the operation on all types
-      # @option arguments [Hash] :body The search definition template and its params
-      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored
-      #                                                 when unavailable (missing or closed)
-      # @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)
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on
-      #                                        (default: random)
+      # @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 [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types
+      # @option arguments [Hash] :body The search definition template and its params (*Required*)
+      # @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, 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 [Duration] :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, query_and_fetch,
-      #                                         dfs_query_then_fetch, dfs_query_and_fetch, count, scan)
+      # @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, query_and_fetch, dfs_query_then_fetch, dfs_query_and_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 This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number
       #
       # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html
       #
       def search_template(arguments={})
         method = HTTP_GET
@@ -52,14 +48,19 @@
       # Register this action with its valid params when the module is loaded.
       #
       # @since 6.2.0
       ParamsRegistry.register(:search_template, [
           :ignore_unavailable,
+          :ignore_throttled,
           :allow_no_indices,
           :expand_wildcards,
           :preference,
           :routing,
           :scroll,
-          :search_type ].freeze)
+          :search_type,
+          :explain,
+          :profile,
+          :typed_keys,
+          :rest_total_hits_as_int ].freeze)
     end
   end
 end