-
Notifications
You must be signed in to change notification settings - Fork 9.2k
Closed
Labels
clarificationrequests to clarify, but not change, part of the specrequests to clarify, but not change, part of the specmedia and encodingIssues regarding media type support and how to encode data (outside of query/path params)Issues regarding media type support and how to encode data (outside of query/path params)
Milestone
Description
See PR #3167 for a lot of context.
In OAS 3.0.3:
- §4.4 Data Types shows
format: bytefor base64-encoded binary data, matching the same section in OAS 2.0 - §4.7.14.3 Considerations for File Uploads has a very minimal example showing
format: base64alongside an example offormat: binary; there is no sign offormat: byte - §4.7.14.5 Special Considerations for
multipartContent mentionsformat: base64alongsideformat: binarywhen talking about defaultContent-Typevalues, but does not mentionformat: byte
It's clear that format: byte was intended to carry over from OAS 2.0, but that base64 is more intuitive and got used everywhere outside of the table of formats.
@OAI/tsc I feel like the most sensible thing to do here would be to define both byte and base64 as having the same effect, and note that byte is compatible with OAS 3.0, while base64 is analogous to using contentEncoding: base64 in OAS 3.1.
I'm guessing that adding a format would not be allowed by SemVer, but we could make the argument that the current situation is so confusing that defining both is just a clarification.
DMRobertsonOctopus
Metadata
Metadata
Assignees
Labels
clarificationrequests to clarify, but not change, part of the specrequests to clarify, but not change, part of the specmedia and encodingIssues regarding media type support and how to encode data (outside of query/path params)Issues regarding media type support and how to encode data (outside of query/path params)