Skip to content

Commit

Permalink
Consistently reference read_mask.
Browse files Browse the repository at this point in the history
  • Loading branch information
rofrankel committed Jul 24, 2024
1 parent 111d40f commit f4c7d80
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions aep/general/0157/aep.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,20 @@ Field masks can be used for granting the user fine-grained control over what
fields are returned. An API **should** support the mask as a request field
named `read_mask`.

- The field mask parameter **must** be optional:
- The `read_mask` parameter **must** be optional:
- An explicit value of `"*"` **should** be supported, and **must** return all
fields.
- If the field mask parameter is omitted, it **must** default to `"*"`,
unless otherwise documented.
- If `read_mask` is omitted, it **must** default to `"*"`, unless otherwise
documented.
- An API **may** allow read masks with non-terminal repeated fields (unlike
update masks), but is not obligated to do so.

**Note:** Changing the default value of the field mask parameter is a
**Note:** Changing the default value of `read_mask` is a
[breaking change](./backwards-compatibility#semantic-changes).

{% tab proto %}

- The value of the field mask parameter **must** be a
`google.protobuf.FieldMask`.
- The value of `read_mask` **must** be a `google.protobuf.FieldMask`.

**Warning:** There is a known conflict between the guidance about
non-terminal repeated fields guidance and the documentation of `FieldMask`
Expand Down

0 comments on commit f4c7d80

Please sign in to comment.