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

Fixed format of 'base64' to correct 'byte' #2192

Closed
wants to merge 1 commit into from
Closed

Conversation

smhc
Copy link

@smhc smhc commented Apr 2, 2020

No description provided.

@handrews
Copy link
Member

handrews commented Apr 3, 2020

I'm not sure this is right [EDIT: it is right], and in any event for 3.1 we should be directing people away from "format": "base64" or "format": "binary" and towards "contentEncoding": "base64", "contentEncoding": "base64url", "contentMediaType": "application/octet-stream", etc.

I'm not sure if we have an issue tracking that, if not I'll file one today.

@hkosova
Copy link
Contributor

hkosova commented Apr 4, 2020

@handrews

I'm not sure if we have an issue tracking that, if not I'll file one today.

#1547?

@handrews
Copy link
Member

handrews commented Apr 4, 2020

@hkosova that's at least related. I didn't manage to file an issue but I discovered a 2/3rds done PR in my local repo. Wonder when I did that... I'll try to post that soonish.

@handrews
Copy link
Member

handrews commented Apr 5, 2020

@smhc all of this stuff is in the middle of being changed around for OAS 3.1, that's why it doesn't make any sense right now.

@handrews
Copy link
Member

handrews commented Apr 5, 2020

Let me finish updating this section with my PR that aligns it with previous work done to update OAS 3.1 to use the latest JSON Schema. If it still doesn't make sense, let's work through it then.

@handrews
Copy link
Member

This is being addressed as part of PR #2200, which drops "format": "byte" entirely in favor of "contentEncoding": "base64". contentEncoding is more flexible, and compatible with the latest JSON Schema (which will be used in OAS 3.1).

If there will be an OAS 3.0.4, then a decision on byte vs base64 is needed, as tracked by #1547, followed by a PR against the appropriate branch. That issue still has not resolved which of byte or base64 was intended. Since this is not against the right branch for 3.0.4 and it's not clear which value is correct, I'm closing this. We'll need a PR against the right branch depending on the outcome of #1547.

@handrews handrews closed this May 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants