[API] Added missing parameters for the "Get Index Settings" and "Put …

…Index Settings" APIs * prefix * ignore_indices * ignore_unavailable * allow_no_indices * expand_wildcards * flat_settings Related: elastic/elasticsearch#4436, elastic/elasticsearch#4453
elastic · Jan 12, 2014 · 8a8e063 · 8a8e063
1 parent 9977a71
commit 8a8e063
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 3 deletions.
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb
@@ -9,19 +9,50 @@ module Actions
         #
         #     client.indices.get_settings
         #
+        # @example Get settings for the 'foo' index
+        #
+        #     client.indices.get_settings index: 'foo'
+        #
+        # @example Get settings for indices beginning with foo
+        #
+        #     client.indices.get_settings prefix: 'foo'
+        #
         # @example Get settings for an index named _myindex_
         #
         #     client.indices.get_settings index: 'myindex'
         #
         # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string
         #                                 to perform the operation on all indices
+        # @option arguments [String] :prefix The prefix all settings must have in order to be included
+        # @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] :ignore_indices When performed on multiple indices, allows to ignore
+        #                                            `missing` ones (options: none, missing) @until 1.0
+        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
+        #                                                 unavailable (missing, closed, etc)
+        # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-get-settings/
         #
         def get_settings(arguments={})
+          valid_params = [
+            :prefix,
+            :ignore_indices,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards,
+            :flat_settings
+          ]
+
           method = 'GET'
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_settings'
-          params = {}
+          path   = Utils.__pathify Utils.__listify(arguments[:index]),
+                                   Utils.__listify(arguments[:type]),
+                                   arguments.delete(:prefix),
+                                   '_settings'
+          params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil
 
           perform_request(method, path, params, body).body

diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb
@@ -37,6 +37,7 @@ module Actions
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
         #                                                 unavailable (missing, closed, etc)
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-update-settings/
         #
@@ -48,7 +49,8 @@ def put_settings(arguments={})
             :ignore_unavailable,
             :allow_no_indices,
             :expand_wildcards,
-            :master_timeout
+            :master_timeout,
+            :flat_settings
           ]
 
           method = 'PUT'