Skip to content

Commit ad4f78f

Browse files
authored
fix(AIP-157): prefix top-level enum values (#1092)
* fix(AIP-157): prefix top-level enum values * add changelog entry
1 parent b7cd2f2 commit ad4f78f

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

aip/general/0157.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,10 @@ enum BookView {
4949
5050
// Include basic metadata about the book, but not the full contents.
5151
// This is the default value (for both ListBooks and GetBook).
52-
BASIC = 1;
52+
BOOK_VIEW_BASIC = 1;
5353
5454
// Include everything.
55-
FULL = 2;
55+
BOOK_VIEW_FULL = 2;
5656
}
5757
```
5858

@@ -66,7 +66,8 @@ enum BookView {
6666
- For Get RPCs, the effective default value **should** be either `BASIC` or
6767
`FULL`.
6868
- The enum **should** be defined at the top level of the proto file (as it is
69-
likely to be needed in multiple requests, e.g. both `Get` and `List`).
69+
likely to be needed in multiple requests, e.g. both `Get` and `List`). See
70+
[AIP-126][] for more guidance on top-level enumerations.
7071
- APIs **may** add fields to a given view over time. APIs **must not** remove a
7172
field from a given view (this is a breaking change).
7273

@@ -81,9 +82,11 @@ enum BookView {
8182

8283
## Changelog
8384

85+
- **2023-05-09**: Fix top-level enum example and link to AIP-126.
8486
- **2022-03-14:** Updated guidance on default value and how to specify a read mask.
8587
- **2021-10-06:** Updated the guidance with system parameters.
8688
- **2021-03-04:** Added guidance for conflicting view enums.
8789

8890
[0]: https://cloud.google.com/apis/docs/system-parameters
8991
[1]: https://grpc.io/docs/what-is-grpc/core-concepts/#metadata
92+
[AIP-126]: ./0126.md

0 commit comments

Comments
 (0)