Skip to content

Discrepancy between encoding multipart/ examples and working with binary data sections #4293

@chrisradek

Description

@chrisradek

In the Open API 3.1.1 spec, there seems to be a discrepancy between how to represent binary data, and the examples around encoding multipart parts.

Working with binary data and migrating binary descriptions from OAS 3.0 indicate that type and format can be removed for raw binary data, and type with contentEncoding can be used (instead of format) for encoded binary data.

The multipart form with multiple files example follows this guidance, but the multipart form with encoding objects still specifies type and format for binary data.

The roughly same example in the Open API 3.1.0 spec uses an empty schema for raw binary data instead of format and type which is what I was expecting: https://spec.openapis.org/oas/v3.1.0.html#encoding-object-example

So I'm wondering if the change between 3.1.0 and 3.1.1 was intentional. Are there any scenarios where we should still be using format of byte or binary with OAS 3.1?

Metadata

Metadata

Assignees

Labels

Type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions