Skip to content

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

@handrews

Description

@handrews

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    clarificationrequests 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)

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions