Update FieldMask Documentation to Align with AIP
#24912
Draft
+2
−8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The update behavior for an empty mask described here directly conflicts with https://google.aip.dev/134, which states: > ... the service **must** treat an omitted field mask as an implied field mask equivalent to all fields that are populated (have a non-empty value). This is confusing, both to human users, and apparently to Gemini, which I noticed wrongly attributed this wording to https://google.aip.dev/161 (which, in actuality, does not mention the empty case at all). Given the wording in `field_mask.proto` is over a decade old (written in the original cl/75054082), let's defer to the AIP's recommendation. Follow suit on requiring a field mask, which https://google.aip.dev/134 precludes: > The [field mask] field **must** be optional ------ Note: We could mention AIP's "*" operator here, but personally I think the AIP is a better place to set explicit conventions rather than in the implementation's documentation. PiperOrigin-RevId: 845560964
copybara-service
bot
force-pushed
the
test_845560964
branch
from
52fa233 to
7d5811f
Compare
copybara-service
bot
changed the title
FieldMask Documentation to Align with AIP
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update
FieldMaskDocumentation to Align with AIPThe update behavior for an empty mask described here directly conflicts with https://google.aip.dev/134, which states:
This is confusing, both to human users, and apparently to Gemini, which I noticed wrongly attributed this wording to https://google.aip.dev/161 (which, in actuality, does not mention the empty case at all).
Given the wording in
field_mask.protois over a decade old (written in the original cl/75054082), let's defer to the AIP's recommendation.Follow suit on requiring a field mask, which https://google.aip.dev/134 precludes:
Note: We could mention AIP's "*" operator here, but personally I think the AIP is a better place to set explicit conventions rather than in the implementation's documentation.