Skip to content

Commit

Permalink
Fix copy-paste "format: binary" error
Browse files Browse the repository at this point in the history
These examples got copied from 3.0.4 and apparently I forgot to
adjust them for 3.1.1 and no one else noticed.
  • Loading branch information
handrews committed Jan 9, 2025
1 parent 4fc2fdb commit dbba0ba
Showing 1 changed file with 16 additions and 20 deletions.
36 changes: 16 additions & 20 deletions src/oas.md
Original file line number Diff line number Diff line change
Expand Up @@ -1800,17 +1800,17 @@ requestBody:
schema:
type: object
properties:
# default for a string without `contentEncoding` is `text/plain`
id:
# default for primitives without a special format is text/plain
type: string
format: uuid
profileImage:
# default for string with binary format is `application/octet-stream`
type: string
format: binary

# default for a schema withhout `type` is `application/octet-stream`
profileImage: {}

# default for arrays is based on the type in the `items`
# subschema, which is an object, so `application/json`
addresses:
# default for arrays is based on the type in the `items`
# subschema, which is an object, so `application/json`
type: array
items:
$ref: '#/components/schemas/Address'
Expand All @@ -1828,31 +1828,27 @@ requestBody:
schema:
type: object
properties:
# No Encoding Object, so use default `text/plain`
id:
# default is `text/plain`
type: string
format: uuid

# Encoding Object overrides the default `application/json`
# for each item in the array with `application/xml; charset=utf-8`
addresses:
# default based on the `items` subschema would be
# `application/json`, but we want these address objects
# serialized as `application/xml` instead
description: addresses in XML format
type: array
items:
$ref: '#/components/schemas/Address'
profileImage:
# default is application/octet-stream, but we can declare
# a more specific image type or types
type: string
format: binary

# Encoding Object accepts only PNG or JPEG, and also describes
# a custom header for just this part in the multipart format
profileImage: {}

encoding:
addresses:
# require XML Content-Type in utf-8 encoding
# This is applied to each address part corresponding
# to each address in he array
contentType: application/xml; charset=utf-8
profileImage:
# only accept png or jpeg
contentType: image/png, image/jpeg
headers:
X-Rate-Limit-Limit:
Expand Down

0 comments on commit dbba0ba

Please sign in to comment.