Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

converge AIP-161 and AIP-203 update field mask guidance for dealing with output only fields #1249

Merged
merged 1 commit into from
Oct 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions aip/general/0161.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,10 +137,9 @@ subfield), the service **must** ignore any output only fields provided as
input, even if they are cleared or modified.

If a user directly specifies an output only field in an update mask, the
service **should** ignore the output only fields provided as input, even if
service **must** ignore the output only fields provided as input, even if
they are cleared or modified, to permit the same field mask to be used for
input and output. However, the service **may** choose to error with
`INVALID_ARGUMENT` if the field is modified in input.
input and output.

### Invalid field mask entries

Expand All @@ -154,4 +153,6 @@ permit deletions.

## Changelog

- **2023-10-18**: Update guidance for presence of output only fields in update
mask.
- **2023-07-17**: Move `update_mask` guidance to AIP-134.
3 changes: 2 additions & 1 deletion aip/general/0203.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,8 @@ The use of `OUTPUT_ONLY` indicates that the field is provided in responses, but
that including the field in a message in a request does nothing (the server
**must** clear out any value in this field and **must not** throw an error as a
result of the presence of a value in this field on input). Similarly, services
**must** ignore the presence of output only fields in update field masks.
**must** ignore the presence of output only fields in update field masks (see:
AIP-161).

Additionally, a field **should** only be described as output only if it is a
field in a resource message, or a field of a message farther down the tree.
Expand Down