docs: Update some Address Validation API proto descriptions to improv…

…e clarity (#11056) * docs: Update some Address Validation API proto descriptions to improve clarity PiperOrigin-RevId: 522445601 Source-Link: googleapis/googleapis@a9a642e Source-Link: googleapis/googleapis-gen@ad764af Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtYWRkcmVzc3ZhbGlkYXRpb24vLk93bEJvdC55YW1sIiwiaCI6ImFkNzY0YWZhZWFlZjMxODYwMzMxNDg2MDU1OGNhYmMxOGE0MWI3MDQifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com>
googleapis · Apr 7, 2023 · 7ca4918 · 7ca4918
1 parent 9f5b7c5
commit 7ca4918
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 5 deletions.
diff --git a/packages/google-maps-addressvalidation/google/maps/addressvalidation_v1/types/address.py b/packages/google-maps-addressvalidation/google/maps/addressvalidation_v1/types/address.py
@@ -31,11 +31,13 @@
 
 
 class Address(proto.Message):
-    r"""Details of the address parsed from the input.
+    r"""Details of the post-processed address. Post-processing
+    includes correcting misspelled parts of the address, replacing
+    incorrect parts, and inferring missing parts.
 
     Attributes:
         formatted_address (str):
-            The corrected address, formatted as a
+            The post-processed address, formatted as a
             single-line address following the address
             formatting rules of the region where the address
             is located.

diff --git a/...ps-addressvalidation/google/maps/addressvalidation_v1/types/address_validation_service.py b/...ps-addressvalidation/google/maps/addressvalidation_v1/types/address_validation_service.py
@@ -210,7 +210,9 @@ class ValidationResult(proto.Message):
             Information about the location and place that
             the address geocoded to.
         metadata (google.maps.addressvalidation_v1.types.AddressMetadata):
-            Other information relevant to deliverability.
+            Other information relevant to deliverability. ``metadata``
+            is not guaranteed to be fully populated for every address
+            sent to the Address Validation API.
         usps_data (google.maps.addressvalidation_v1.types.UspsData):
             Extra deliverability flags provided by USPS. Only provided
             in region ``US`` and ``PR``.

diff --git a/packages/google-maps-addressvalidation/google/maps/addressvalidation_v1/types/metadata_.py b/packages/google-maps-addressvalidation/google/maps/addressvalidation_v1/types/metadata_.py
@@ -28,7 +28,10 @@
 
 
 class AddressMetadata(proto.Message):
-    r"""The metadata for the address.
+    r"""The metadata for the address. ``metadata`` is not guaranteed to be
+    fully populated for every address sent to the Address Validation
+    API.
+
 
     .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
 

diff --git a/packages/google-maps-addressvalidation/google/maps/addressvalidation_v1/types/usps_data.py b/packages/google-maps-addressvalidation/google/maps/addressvalidation_v1/types/usps_data.py
@@ -91,7 +91,11 @@ class UspsAddress(proto.Message):
 
 
 class UspsData(proto.Message):
-    r"""The USPS data for the address.
+    r"""The USPS data for the address. ``uspsData`` is not guaranteed to be
+    fully populated for every US or PR address sent to the Address
+    Validation API. It's recommended to integrate the backup address
+    fields in the response if you utilize uspsData as the primary part
+    of the response.
 
     Attributes:
         standardized_address (google.maps.addressvalidation_v1.types.UspsAddress):