Skip to content

Commit

Permalink
[AIP-134] Add rationale on update_mask being optional
Browse files Browse the repository at this point in the history
Add text explaining why `update_mask` must be OPTIONAL over REQUIRED.
  • Loading branch information
itsStrobe authored Aug 10, 2024
1 parent 3c0b8a3 commit 0a1b135
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions aip/general/0134.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,9 @@ message UpdateBookRequest {
- The field **must** be optional, and 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).
- Rationale is that omission of `update_mask` is equivalent on it being
empty. Marking this field as `REQUIRED` provides no benefit to the API
and results in an inconsistent experience across services.
- Update masks **must** support a special value `*`, meaning full replacement
(the equivalent of `PUT`).
- The request message **must not** contain any other required fields, and
Expand Down

0 comments on commit 0a1b135

Please sign in to comment.