We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 029ab09 commit 7470d8aCopy full SHA for 7470d8a
1 file changed
aep/general/0140/aep.md.j2
@@ -138,7 +138,21 @@ base64-encode a field into a `string` field.
138
139
{% tab oas %}
140
141
-**Note:** OAS guidance not yet written.
+When sending binary data over the wire, the field name **should** be suffixed
142
+with "\_bytes". The contents of the field **should** be base64-encoded over the
143
+wire. The field **should** be annotated with `contentEncoding: base64` and
144
+**may** include `contentMediaType` to specify the media type of the binary
145
+data.
146
+
147
+For example:
148
149
+```yaml
150
+profile_image_bytes:
151
+ type: string
152
+ contentEncoding: base64
153
+ contentMediaType: image/png
154
+ description: The user's profile image as a base64-encoded PNG.
155
+```
156
157
{% endtabs %}
158
0 commit comments