Skip to content

More contentEncoding example improvements (from feedback) #4301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 17, 2025
Merged

More contentEncoding example improvements (from feedback) #4301

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b0a31a
Feedback from mkistler about contentEncoding
handrews Jan 15, 2025
628e971
Apply suggestions from code review
ralfhandl Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions src/oas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1746,8 +1746,9 @@ requestBody:
name:
type: string
icon:
# The default with "contentEncoding" is application/octet-stream,
# so we need to set image media type(s) in the Encoding Object.
# The default content type with "contentEncoding" present
# is application/octet-stream, so we need to set the correct
# image media type(s) in the Encoding Object.
type: string
contentEncoding: base64url
encoding:
Expand Down Expand Up @@ -1800,16 +1801,19 @@ requestBody:
schema:
type: object
properties:
# default for a string without `contentEncoding` is `text/plain`
# default content type for a string without `contentEncoding`
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# default content type for a string without `contentEncoding`
# default content type for a string without "contentEncoding"

Align with line 1749

# is `text/plain`
id:
type: string
format: uuid

# default for a schema without `type` is `application/octet-stream`
# default content type for a schema without `type`
# is `application/octet-stream`
Comment on lines +1810 to +1811
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# default content type for a schema without `type`
# is `application/octet-stream`
# default content type for a schema without "type"
# is application/octet-stream

Align with lines 1749-1750

profileImage: {}

# default for arrays is based on the type in the `items`
# subschema, which is an object, so `application/json`
# default content type for arrays is based on the type
# in the `items` subschema, which is an object here,
# so the default content type for each item is `application/json`
Comment on lines +1815 to +1816
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# in the `items` subschema, which is an object here,
# so the default content type for each item is `application/json`
# in the "items" subschema, which is an object here,
# so the default content type for each item is application/json

addresses:
type: array
items:
Expand All @@ -1833,7 +1837,7 @@ requestBody:
type: string
format: uuid

# Encoding Object overrides the default `application/json`
# Encoding Object overrides the default `application/json` content type
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# Encoding Object overrides the default `application/json` content type
# Encoding Object overrides the default application/json content type

# for each item in the array with `application/xml; charset=utf-8`
addresses:
description: addresses in XML format
Expand Down
Loading