Skip to content

Commit 3205421

Browse files
committed
Henry's remarks
1 parent 40a041b commit 3205421

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

src/oas.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2071,7 +2071,7 @@ requestBody:
20712071
type: string
20722072
icon:
20732073
# The default content type with `contentEncoding` present
2074-
# is "application/octet-stream", so we need to set the correct
2074+
# is `application/octet-stream`, so we need to set the correct
20752075
# image media type(s) in the Encoding Object.
20762076
type: string
20772077
contentEncoding: base64url
@@ -2128,20 +2128,20 @@ requestBody:
21282128
type: object
21292129
properties:
21302130
# default content type for a string without `contentEncoding`
2131-
# is "text/plain"
2131+
# is `text/plain`
21322132
id:
21332133
type: string
21342134
format: uuid
21352135

21362136
# default content type for a schema without `type`
2137-
# is "application/octet-stream"
2137+
# is `application/octet-stream`
21382138
profileImage: {}
21392139

21402140
# for arrays, the `encoding` field applies the Encoding Object
21412141
# to each item individually and determines the default content type
21422142
# based on the type in the `items` subschema, which in this example
21432143
# is an object, so the default content type for each item is
2144-
# "application/json"
2144+
# `application/json`
21452145
addresses:
21462146
type: array
21472147
items:
@@ -2160,13 +2160,13 @@ requestBody:
21602160
schema:
21612161
type: object
21622162
properties:
2163-
# No Encoding Object, so use default "text/plain"
2163+
# No Encoding Object, so use default `text/plain`
21642164
id:
21652165
type: string
21662166
format: uuid
21672167

2168-
# Encoding Object overrides the default "application/json" content type
2169-
# for each item in the array with "application/xml; charset=utf-8"
2168+
# Encoding Object overrides the default `application/json` content type
2169+
# for each item in the array with `application/xml; charset=utf-8`
21702170
addresses:
21712171
description: addresses in XML format
21722172
type: array
@@ -2217,7 +2217,7 @@ multipart/mixed:
22172217
type: array
22182218
prefixItems:
22192219
- # default content type for objects
2220-
# is "application/json"
2220+
# is `application/json`
22212221
type: object
22222222
properties:
22232223
author:
@@ -2230,7 +2230,7 @@ multipart/mixed:
22302230
license:
22312231
type: string
22322232
- # default content type for a schema without `type`
2233-
# is "application/octet-stream", which we need
2233+
# is `application/octet-stream`, which we need
22342234
# to override.
22352235
{}
22362236
prefixEncoding:
@@ -5395,7 +5395,7 @@ components:
53955395
In this example, the retrieval URIs are irrelevant because both documents define `$self`.
53965396

53975397
The relative `$ref` in the first document is resolved against `$self` to produce `https://example.com/api/shared/foo#/components/requestBodies/Foo`.
5398-
The portion of that URI before the "#" matches the `$self` of the second document, so the reference target is resolved to `#/components/requestBodies/Foo` in that second document.
5398+
The portion of that URI before the `#` matches the `$self` of the second document, so the reference target is resolved to `#/components/requestBodies/Foo` in that second document.
53995399

54005400
In that document, the `$ref` in the Request Body Object is resolved using that document's `$self` as the base URI, producing `https://example.com/api/schemas/foo`.
54015401
This matches the `$id` at `#/components/schemas/Foo/$id` so it points to that Schema Object.

0 commit comments

Comments
 (0)