field_mask.rb in google-cloud-vision-0.32.3

- old
+ new

@@ -1,6 +1,6 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed 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
 #
@@ -81,60 +81,52 @@
     # to only change the values of the fields as specified in the mask
     # and leave the others untouched. If a resource is passed in to
     # describe the updated values, the API ignores the values of all
     # fields not covered by the mask.
     #
-    # If a repeated field is specified for an update operation, the existing
-    # repeated values in the target resource will be overwritten by the new values.
-    # Note that a repeated field is only allowed in the last position of a `paths`
-    # string.
+    # If a repeated field is specified for an update operation, new values will
+    # be appended to the existing repeated field in the target resource. Note that
+    # a repeated field is only allowed in the last position of a `paths` string.
     #
     # If a sub-message is specified in the last position of the field mask for an
-    # update operation, then the existing sub-message in the target resource is
-    # overwritten. Given the target message:
+    # update operation, then new value will be merged into the existing sub-message
+    # in the target resource.
     #
+    # For example, given the target message:
+    #
     #     f {
     #       b {
-    #         d : 1
-    #         x : 2
+    #         d: 1
+    #         x: 2
     #       }
-    #       c : 1
+    #       c: [1]
     #     }
     #
     # And an update message:
     #
     #     f {
     #       b {
-    #         d : 10
+    #         d: 10
     #       }
+    #       c: [2]
     #     }
     #
     # then if the field mask is:
     #
-    #  paths: "f.b"
+    #  paths: ["f.b", "f.c"]
     #
     # then the result will be:
     #
     #     f {
     #       b {
-    #         d : 10
+    #         d: 10
+    #         x: 2
     #       }
-    #       c : 1
+    #       c: [1, 2]
     #     }
     #
-    # However, if the update mask was:
-    #
-    #  paths: "f.b.d"
-    #
-    # then the result would be:
-    #
-    #     f {
-    #       b {
-    #         d : 10
-    #         x : 2
-    #       }
-    #       c : 1
-    #     }
+    # An implementation may provide options to override this default behavior for
+    # repeated and message fields.
     #
     # In order to reset a field's value to the default, the field must
     # be in the mask and set to the default value in the provided resource.
     # Hence, in order to reset all fields of a resource, provide a default
     # instance of the resource and set all fields in the mask, or do
\ No newline at end of file