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

Inconsistent or unclear string format : byte or base64 #3886

Closed
sjbenoist opened this issue Jun 5, 2024 · 1 comment
Closed

Inconsistent or unclear string format : byte or base64 #3886

sjbenoist opened this issue Jun 5, 2024 · 1 comment

Comments

@sjbenoist
Copy link

The OpenAPI 3.0.3 specification states in section 4.4 that it defines formats "byte" as base64 encoded characters and "binary" as any sequence of octets.

However, section 4.7.14.3 Considerations for File Uploads, mentions two alternative options for content transfer, either with base64 encoding or in binary. The values used for "format" are "base64" and "binary".

Section 4.7.14.5 Special considerations for multipart conten also mentions format:binary and format:base64 as markers implying that the default content-Type is application/octet-stream

"base64" as a possible value for format is not defined by the specification and is therefore ambiguous. Is it a synonym of the "byte" value ? Why should implementations support two different values if they are synonyms ?

@handrews
Copy link
Member

handrews commented Jun 5, 2024

@sjbenoist this has been fixed for 3.0.4 which will be published soon, and entries have been added in the formats registry for managing compatibility across versions (in 3.1, the byte and binary formats were replaced with contentEncoding):

@handrews handrews closed this as completed Jun 5, 2024
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

No branches or pull requests

2 participants