Skip to content

Commit ccf629f

Browse files
authored
fix(AIP-140): identify exception to base64-encoded string guidance (#1412)
* fix(AIP-140): identify exception to base64-encoded string guidance * chore(AIP-140): fix typo
1 parent e589747 commit ccf629f

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

aip/general/0140.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,10 @@ are an exception to this rule. For example, `is_new` (**not** `new`).
120120
When using `bytes`, the contents of the field are base64-encoded when using
121121
JSON on the wire. Services **should** use `bytes` when there is a need to send
122122
binary contents over the wire, and **should not** ask the user to manually
123-
base64-encode a field into a `string` field.
123+
base64-encode a field into a `string` field. The one exception is when the
124+
API is designed to handle data that is meant to be base64-encoded at rest and
125+
the double base64-encoding as a result of using `bytes` is undesirable - in
126+
this case, services **may** use a `string`.
124127

125128
### URIs
126129

@@ -159,6 +162,7 @@ field **should not** have a uniqueness requirement.
159162

160163
## Changelog
161164

165+
- **2024-08-26**: Codify exception to string and base64 guidance
162166
- **2024-05-18**: Documented the effect of field names on client surfaces.
163167
- **2023-04-25**: Field names **must not** be expressed as verbs.
164168
- **2021-07-12**: Normalized display name guidance to "should".

0 commit comments

Comments
 (0)