Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify "format": "byte" vs "format": "base64" in OAS 3.0.x #3174

Closed
handrews opened this issue Feb 28, 2023 · 0 comments
Closed

Clarify "format": "byte" vs "format": "base64" in OAS 3.0.x #3174

handrews opened this issue Feb 28, 2023 · 0 comments
Labels
clarification requests to clarify, but not change, part of the spec media and encoding Issues regarding media type support and how to encode data (outside of query/path params)
Milestone

Comments

@handrews
Copy link
Member

See PR #3167 for a lot of context.

In OAS 3.0.3:

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.

@handrews handrews added the 3.0.4 label Feb 28, 2023
@handrews handrews closed this as completed Mar 5, 2023
@handrews handrews added this to the v3.0.4 milestone Jan 27, 2024
@handrews handrews removed the 3.0.4 label Jan 27, 2024
@handrews handrews added clarification requests to clarify, but not change, part of the spec media and encoding Issues regarding media type support and how to encode data (outside of query/path params) labels May 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clarification requests to clarify, but not change, part of the spec media and encoding Issues regarding media type support and how to encode data (outside of query/path params)
Projects
None yet
Development

No branches or pull requests

1 participant