Skip to content

Commit 352bcc4

Browse files
authored
fix(AIP-134): add full replace usage caveats (#1453)
1 parent 91c0f08 commit 352bcc4

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

aip/general/0134.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,11 @@ message UpdateBookRequest {
105105
populated (have a non-empty value).
106106
- Update masks **must** support a special value `*`, meaning full replacement
107107
(the equivalent of `PUT`).
108+
- API producers need to be conscious of how adding new, mutable fields to a
109+
resource will be handled when consumers use `*` without knowledge of said
110+
new, mutable fields. Likewise consumers need to use `*` only when the
111+
risks of doing so are acceptable. In general, it is safest to explicitly
112+
specify the fields to update rather than use `*`.
108113
- The request message **must not** contain any other required fields, and
109114
**should not** contain other optional fields except those described in this
110115
or another AIP.
@@ -297,6 +302,7 @@ does not exist, the service **must** error with `NOT_FOUND` (HTTP 404) unless
297302

298303
## Changelog
299304

305+
- **2024-12-03**: Add caveats to usage of full replacement `update_mask`.
300306
- **2024-03-14**: Make `update_mask` optional field_behaviour guidance a **must**.
301307
- **2023-08-26**: Adding consistency requirement.
302308
- **2023-07-17**: Make `update_mask` name guidance a **must**.

0 commit comments

Comments
 (0)