Skip to content

Clarify the use of "binary" and "byte" formats - #3187

Merged
darrelmiller merged 1 commit into
OAI:v3.0.4-devfrom
handrews:using-byte-binary
Mar 11, 2023
Merged

Clarify the use of "binary" and "byte" formats#3187
darrelmiller merged 1 commit into
OAI:v3.0.4-devfrom
handrews:using-byte-binary

Conversation

@handrews

Copy link
Copy Markdown
Member

Fixes#1544 and #3175.

Add a brief explanation as a subsection of Data Types, and update the relevant examples. Specifically:

  • Don't use format: byte for a whole message body
  • Fix multipart/mixed example to be multipart/form-data (because multipart/mixed does not name its parts and therefore cannot be represented with an object schema)
  • Add an application/x-www-form-urlencoded example, which is where format: byte needs to be used

Add a brief explanation as a subsection of Data Types, and
update the relevant examples. Specifically:
* Don't use `format: byte` for a whole message body
* Fix `multipart/mixed` example to be `multipart/form-data`
(because `multipart/mixed` does not name its parts and
therefore cannot be represented with an object schema)
* Add an `application/x-www-form-urlencoded` example,
which is where `format: byte` needs to be used

@MikeRalphsonMikeRalphson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM thanks

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@handrews@MikeRalphson@darrelmiller@ralfhandl@CALIFAS95