get_field_mapping.rb in elasticsearch-api-6.3.0

- old
+ new

@@ -16,24 +16,19 @@
         # @example Get mappings for multiple fields in an index
         #
         #     client.indices.get_field_mapping index: 'foo', field: ['bar', 'bam']
         #
         # @option arguments [List] :index A comma-separated list of index names
-        # @option arguments [List] :type  A comma-separated list of document types
-        # @option arguments [List] :field A comma-separated list of fields (*Required*)
-        # @option arguments [Boolean] :include_defaults Whether default mapping values should be returned as well
-        # @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 [List] :type A comma-separated list of document types
+        # @option arguments [List] :fields A comma-separated list of fields (*Required*)
+        # @option arguments [Boolean] :include_defaults Whether the default mapping values should be returned as well
+        # @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, none, all)
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html
         #
         def get_field_mapping(arguments={})
           arguments = arguments.clone
           fields = arguments.delete(:field) || arguments.delete(:fields)
           raise ArgumentError, "Required argument 'field' missing" unless fields
@@ -54,13 +49,14 @@
         # Register this action with its valid params when the module is loaded.
         #
         # @since 6.2.0
         ParamsRegistry.register(:get_field_mapping, [
             :include_defaults,
-            :ignore_indices,
             :ignore_unavailable,
             :allow_no_indices,
-            :expand_wildcards ].freeze)
+            :expand_wildcards,
+            :local,
+            :include_type_name ].freeze)
       end
     end
   end
 end