Skip to content

Commit

Permalink
Clarify how to model streaming binary data (3.1.1)
Browse files Browse the repository at this point in the history
Also make the translation from 3.0 binary modeling a subsection,
as otherwise the line about streaming either feels randomly inserted
into the middle of the section, or feels disconnected when placed
after the conversion table.
  • Loading branch information
handrews committed May 1, 2024
1 parent 324c8f1 commit afe8bb2
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions versions/3.1.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,9 @@ The `contentMediaType` keyword is redundant if the media type is already set:

If the Schema Object will be processed by a non-OAS-aware JSON Schema implementation, it may be useful to include `contentMediaType` even if it is redundant. However, if `contentMediaType` contradicts a relevant Media Type Object or Encoding Object, then `contentMediaType` SHALL be ignored.

The `maxLength` keyword MAY be used to set an expected upper bound on the length of a streaming payload. The keyword can be applied to either string data, including encoded binary data, or to unencoded binary data. For unencoded binary, the length is the number of octets.

##### Migrating binary descriptions from OAS 3.0
The following table shows how to migrate from OAS 3.0 binary data descriptions, continuing to use `image/png` as the example binary media type:

OAS < 3.1 | OAS 3.1 | Comments
Expand Down

0 comments on commit afe8bb2

Please sign in to comment.