Skip to content

Commit 47f5fec

Browse files
committed
Fix examples object example and api-with-examples
1 parent eedf153 commit 47f5fec

File tree

2 files changed

+26
-17
lines changed

2 files changed

+26
-17
lines changed

examples/v3.0/api-with-examples.yaml

+12-8
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ paths:
1414
content:
1515
application/json:
1616
examples:
17-
- {
17+
foo:
18+
value: {
1819
"versions": [
1920
{
2021
"status": "CURRENT",
@@ -46,10 +47,11 @@ paths:
4647
content:
4748
application/json:
4849
examples:
49-
- |
50-
{
50+
foo:
51+
value: |
52+
{
5153
"versions": [
52-
{
54+
{
5355
"status": "CURRENT",
5456
"updated": "2011-01-21T11:33:21Z",
5557
"id": "v2.0",
@@ -72,7 +74,7 @@ paths:
7274
]
7375
}
7476
]
75-
}
77+
}
7678
/v2:
7779
get:
7880
operationId: getVersionDetailsv2
@@ -84,7 +86,8 @@ paths:
8486
content:
8587
application/json:
8688
examples:
87-
- {
89+
foo:
90+
value: {
8891
"version": {
8992
"status": "CURRENT",
9093
"updated": "2011-01-21T11:33:21Z",
@@ -128,7 +131,8 @@ paths:
128131
content:
129132
application/json:
130133
examples:
131-
- {
134+
foo:
135+
value: {
132136
"version": {
133137
"status": "CURRENT",
134138
"updated": "2011-01-21T11:33:21Z",
@@ -160,4 +164,4 @@ paths:
160164
}
161165
]
162166
}
163-
}
167+
}

versions/3.0.md

+14-9
Original file line numberDiff line numberDiff line change
@@ -2205,21 +2205,25 @@ schemas:
22052205
example:
22062206
$ref: http://foo.bar#/examples/name-example
22072207
2208-
# in a request body, note the plural `examples` as the Content-Type is set to `*`:
2208+
# in a request body, note the plural `examples`
22092209
requestBody:
22102210
content:
22112211
'application/json':
22122212
schema:
22132213
$ref: '#/components/schemas/Address'
2214-
examples:
2215-
- {"foo": "bar"}
2216-
- {"bar": "baz"}
2214+
examples:
2215+
foo:
2216+
value: {"foo": "bar"}
2217+
bar:
2218+
value: {"bar": "baz"}
22172219
'application/xml':
2218-
examples:
2219-
- $ref: 'http://foo.bar#/examples/address-example.xml'
2220+
examples:
2221+
xml:
2222+
externalValue: 'http://foo.bar/examples/address-example.xml'
22202223
'text/plain':
2221-
examples:
2222-
- $ref: 'http://foo.bar#/examples/address-example.txt'
2224+
examples:
2225+
text:
2226+
externalValue: 'http://foo.bar/examples/address-example.txt'
22232227

22242228
# in a parameter
22252229
parameters:
@@ -2230,7 +2234,8 @@ schemas:
22302234
format: 'zip-code'
22312235
example:
22322236
$ref: 'http://foo.bar#/examples/zip-example'
2233-
# in a response, note the plural `examples`:
2237+
2238+
# in a response, note the singular `example`:
22342239
responses:
22352240
'200':
22362241
description: your car appointment has been booked

0 commit comments

Comments
 (0)