Skip to content

Commit c5fafb3

Browse files
cleanup: removed json-style format from yaml examples
...and fixed a deprecated "value" in an example
1 parent a04789f commit c5fafb3

1 file changed

Lines changed: 27 additions & 35 deletions

File tree

src/oas.md

Lines changed: 27 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -966,7 +966,7 @@ examples:
966966
dataValue:
967967
- 12345678
968968
- 90099
969-
serializedValue: "12345678,90099"
969+
serializedValue: 12345678,90099
970970
```
971971

972972

@@ -993,7 +993,7 @@ examples:
993993
dataValue:
994994
greeting: Hello%2C%20world!
995995
code: 42
996-
serializedValue: "greeting=Hello%2C%20world!; code=42"
996+
serializedValue: greeting=Hello%2C%20world!; code=42
997997
```
998998
999999
A cookie parameter relying on the percent-encoding behavior of the default `style: "form"`:
@@ -1012,7 +1012,7 @@ examples:
10121012
characters, rather than just the one non-cookie-safe
10131013
character, getting percent-encoded.
10141014
dataValue: Hello, world!
1015-
serializedValue: "greeting=Hello%2C%20world%21"
1015+
serializedValue: greeting=Hello%2C%20world%21
10161016
```
10171017

10181018
A path parameter of a string value:
@@ -1025,15 +1025,15 @@ required: true
10251025
schema:
10261026
type: string
10271027
examples:
1028-
"Edsger Dijkstra":
1028+
Edsger Dijkstra:
10291029
dataValue: edijkstra
10301030
serializedValue: edijkstra
10311031
Diṅnāga:
10321032
dataValue: diṅnāga
10331033
serializedValue: di%E1%B9%85n%C4%81ga
10341034
Al-Khwarizmi:
10351035
dataValue: "الخوارزميّ"
1036-
serializedValue: "%D8%A7%D9%84%D8%AE%D9%88%D8%A7%D8%B1%D8%B2%D9%85%D9%8A%D9%91"
1036+
serializedValue: %D8%A7%D9%84%D8%AE%D9%88%D8%A7%D8%B1%D8%B2%D9%85%D9%8A%D9%91
10371037
```
10381038

10391039
An optional query parameter of a string value, allowing multiple values by repeating the query parameter
@@ -1054,7 +1054,7 @@ examples:
10541054
dataValue:
10551055
- one thing
10561056
- another thing
1057-
serializedValue: "thing=one%20thing&thing=another%20thing"
1057+
serializedValue: thing=one%20thing&thing=another%20thing
10581058
```
10591059

10601060
A free-form query parameter, allowing arbitrary parameters of `type: "integer"`:
@@ -1174,7 +1174,7 @@ examples:
11741174
- 1
11751175
- 2
11761176
flag: null
1177-
serializedValue: "%7B%22numbers%22%3A%5B1%2C2%5D%2C%22flag%22%3Anull%7D"
1177+
serializedValue: %7B%22numbers%22%3A%5B1%2C2%5D%2C%22flag%22%3Anull%7D
11781178
```
11791179

11801180
Assuming a path of `/foo`, a server of `https://example.com`, the full URL incorporating the value from `serializedValue` would be:
@@ -1449,22 +1449,20 @@ application/json:
14491449
examples:
14501450
cat:
14511451
summary: An example of a cat
1452-
value: {
1453-
"name": "Fluffy",
1454-
"petType": "Cat",
1455-
"color": "White",
1456-
"gender": "male",
1457-
"breed": "Persian"
1458-
}
1452+
value:
1453+
name: Fluffy
1454+
petType: Cat
1455+
color: White
1456+
gender: male
1457+
breed: Persian
14591458
dog:
14601459
summary: An example of a dog with a cat's name
1461-
value: {
1462-
"name": "Puma",
1463-
"petType": "Dog",
1464-
"color": "Black",
1465-
"gender": "Female",
1466-
"breed": "Mixed"
1467-
}
1460+
value:
1461+
name: Puma
1462+
petType: Dog
1463+
color: Black
1464+
gender: Female
1465+
breed: Mixed
14681466
frog:
14691467
$ref: '#/components/examples/frog-example'
14701468
```
@@ -1509,7 +1507,7 @@ components:
15091507
description: JSONL and NDJSON are identical for this example
15101508
# Note that the value must be written as a string with newlines,
15111509
# as JSONL and NDJSON are not valid YAML
1512-
value: |
1510+
serializedValue: |
15131511
{"timestamp": "1985-04-12T23:20:50.52Z", "level": 1, "message": "Hi!"}
15141512
{"timestamp": "1985-04-12T23:20:51.37Z", "level": 1, "message": "Bye!"}
15151513
responses:
@@ -2446,12 +2444,7 @@ content:
24462444
author: A. Writer
24472445
title: An Older Book
24482446
rating: 4.5
2449-
serializedValue: |
2450-
{
2451-
"author": "A. Writer",
2452-
"title": "An Older Book",
2453-
"rating": 4.5
2454-
}
2447+
serializedValue: {"author":"A. Writer","title":"An Older Book","rating":4.5}
24552448
```
24562449

24572450
##### Binary Examples
@@ -2478,10 +2471,10 @@ required: true
24782471
schema:
24792472
type: boolean
24802473
examples:
2481-
"true":
2474+
'true':
24822475
dataValue: true
24832476
serializedValue: flag=true
2484-
"false":
2477+
'false':
24852478
dataValue: false
24862479
serializedValue: flag=false
24872480
```
@@ -2849,11 +2842,10 @@ components:
28492842
explode: true
28502843
examples:
28512844
SetCookies:
2852-
dataValue: {
2853-
"lang": "en-US; Expires=Wed, 09 Jun 2021 10:18:14 GMT"
2854-
"foo": "bar; Expires=Wed, 09 Jun 2021 10:18:14 GMT"
2855-
"urlSafeData": "Hello%2C%20world%21"
2856-
}
2845+
dataValue:
2846+
lang: en-US; Expires=Wed, 09 Jun 2021 10:18:14 GMT
2847+
foo: bar; Expires=Wed, 09 Jun 2021 10:18:14 GMT
2848+
urlSafeData: Hello%2C%20world%21
28572849
serializedValue: |
28582850
lang=en-US; Expires=Wed, 09 Jun 2021 10:18:14 GMT
28592851
foo=bar; Expires=Wed, 09 Jun 2021 10:18:14 GMT

0 commit comments

Comments
 (0)