Skip to content

Commit 783b844

Browse files
Field naming: Adding a note for client side impact (#1355)
* Field naming - client side impact * indentation * Highlight the node and added changelog --------- Co-authored-by: Noah Dietz <noahdietz@users.noreply.github.com>
1 parent 50046a5 commit 783b844

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

aip/general/0140.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ including adjectives that always apply and add little cognitive value. For
3333
example, a `proxy_settings` field might be as helpful as
3434
`shared_proxy_settings` if there is no unshared variant.
3535

36+
**Important:** Field names often appear in generated client surfaces. Ensure they
37+
are appropriately descriptive and of suitable length.
38+
3639
### Case
3740

3841
Field definitions in protobuf files **must** use `lower_snake_case` names.
@@ -156,6 +159,7 @@ field **should not** have a uniqueness requirement.
156159

157160
## Changelog
158161

162+
- **2024-05-18**: Documented the effect of field names on client surfaces.
159163
- **2023-04-25**: Field names **must not** be expressed as verbs.
160164
- **2021-07-12**: Normalized display name guidance to "should".
161165
- **2021-04-07**: Added base64 and bytes guidance.

0 commit comments

Comments
 (0)