Skip to content

chore(AIP-157): add historical rationale for read_mask #1513

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.

Sign up for GitHub

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

Closed
noahdietz wants to merge 1 commit into from
Closed

chore(AIP-157): add historical rationale for read_mask #1513

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 12 additions & 2 deletions aip/general/0157.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,21 @@ enum BookView {

### Read masks as a request field

**Warning:** Read masks as a single field on the request message, for example: `google.protobuf.FieldMask read_mask` are **DEPRECATED**.
**Warning:** Read masks as a single field on the request message, for example: `google.protobuf.FieldMask read_mask` are **DEPRECATED**. Users and Google APIs **must** instead consult the `fields`
[system parameter](https://cloud.google.com/apis/docs/system-parameters).

## Rationale

### Discontinuing `read_mask`

Long before the `read_mask` request field was introduced, Google APIs at a
system level supported the same functionality via the system parameter `fields`.
So, `read_mask` as a request field was discontinued to dedupe the functionality.

## Changelog

- **2023-05-09**: Fix top-level enum example and link to AIP-126.
- **2025-05-12:** Add historical rationale for read_mask discontinuation.
- **2023-05-09:** Fix top-level enum example and link to AIP-126.
- **2022-03-14:** Updated guidance on default value and how to specify a read mask.
- **2021-10-06:** Updated the guidance with system parameters.
- **2021-03-04:** Added guidance for conflicting view enums.
Expand Down