Skip to content

Commit a0502e7

Browse files
handrewshandrews
committed
No new external fields for the Example Object
1 parent 67b34d4 commit a0502e7

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

‎src/oas.md

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3274,7 +3274,7 @@ For examples using `attribute` or `wrapped`, please see version 3.1 of the OpenA
32743274

32753275
###### No XML Object
32763276

3277-
Basic string property without an XML Object, using `serializedValue` (the remaining examples will use `externalSerializedValue` so that the XML form can be shown with syntax highlighting):
3277+
Basic string property without an XML Object, using `serializedValue` (the remaining examples will use `externalValue` so that the XML form can be shown with syntax highlighting):
32783278

32793279
```yaml
32803280
application/xml:
@@ -3312,7 +3312,7 @@ application/xml:
33123312
pets:
33133313
dataValue:
33143314
animals: [dog, cat, hamster]
3315-
externalSerializedValue: ./examples/pets.xml
3315+
externalValue: ./examples/pets.xml
33163316
```
33173317

33183318
Where `./examples/pets.xml` would be:
@@ -3342,7 +3342,7 @@ application/xml:
33423342
pets:
33433343
dataValue:
33443344
animals: [dog, cat, hamster]
3345-
externalSerializedValue: ./examples/pets.xml
3345+
externalValue: ./examples/pets.xml
33463346
```
33473347

33483348
Where `./examples/pets.xml` would be:
@@ -3386,7 +3386,7 @@ components:
33863386
dataValue:
33873387
id: 123
33883388
name: example
3389-
externalSerializedValue: ./examples/Person.xml
3389+
externalValue: ./examples/Person.xml
33903390
```
33913391

33923392
Where `./examples/Person.xml` would be:
@@ -3418,7 +3418,7 @@ application/xml:
34183418
pets:
34193419
dataValue:
34203420
animals: [dog, cat, hamster]
3421-
externalSerializedValue: ./examples/pets.xml
3421+
externalValue: ./examples/pets.xml
34223422
```
34233423

34243424
Where `./examples/pets.xml` would be:
@@ -3452,7 +3452,7 @@ application/xml:
34523452
pets:
34533453
dataValue:
34543454
animals: [dog, cat, hamster]
3455-
externalSerializedValue: ./examples/pets.xml
3455+
externalValue: ./examples/pets.xml
34563456
```
34573457

34583458
Where `./examples/pets.xml` would be:
@@ -3484,7 +3484,7 @@ application/xml:
34843484
pets:
34853485
dataValue:
34863486
animals: [dog, cat, hamster]
3487-
externalSerializedValue: ./examples/pets.xml
3487+
externalValue: ./examples/pets.xml
34883488
```
34893489

34903490
Where `./examples/pets.xml` would be:
@@ -3520,7 +3520,7 @@ application/xml:
35203520
pets:
35213521
dataValue:
35223522
animals: [dog, cat, hamster]
3523-
externalSerializedValue: ./examples/pets.xml
3523+
externalValue: ./examples/pets.xml
35243524
```
35253525

35263526
Where `./examples/pets.xml` would be:
@@ -3557,7 +3557,7 @@ application/xml:
35573557
pets:
35583558
dataValue:
35593559
animals: [dog, cat, hamster]
3560-
externalSerializedValue: ./examples/pets.xml
3560+
externalValue: ./examples/pets.xml
35613561
```
35623562

35633563
Where `./examples/pets.xml` would be:
@@ -3592,7 +3592,7 @@ application/xml:
35923592
pets:
35933593
dataValue:
35943594
animals: [dog, cat, hamster]
3595-
externalSerializedValue: ./examples/pets.xml
3595+
externalValue: ./examples/pets.xml
35963596
```
35973597

35983598
Where `./examples/pets.xml` would be:
@@ -3671,7 +3671,7 @@ components:
36713671
docs:
36723672
dataValue:
36733673
content: <html><head><title>Awesome Docs</title></head><body></body><html>
3674-
externalSerializedValue: ./examples/docs.xml
3674+
externalValue: ./examples/docs.xml
36753675
```
36763676

36773677
Where `./examples/docs.xml` would be:
@@ -3682,7 +3682,7 @@ Where `./examples/docs.xml` would be:
36823682
</Documentation>
36833683
```
36843684

3685-
Alternatively, the named root element could be set at the point of use and the root element disabled on the component:
3685+
Alternatively, the named root element could be set at the point of use and the root element disabled on the component (note that in this example, the same `dataValue` is used in two places with different serializations shown with `externalValue`):
36863686

36873687
```yaml
36883688
paths:
@@ -3699,8 +3699,10 @@ paths:
36993699
$ref: "#/components/schemas/Documentation"
37003700
examples:
37013701
stored:
3702-
externalDataValue: ./examples/content.json
3703-
externalSerializedValue: ./examples/stored.xml
3702+
dataValue: {
3703+
"content": "<html><head><title>Awesome Docs</title></head><body></body><html>"
3704+
}
3705+
externalValue: ./examples/stored.xml
37043706
put:
37053707
requestBody:
37063708
required: true
@@ -3713,8 +3715,10 @@ paths:
37133715
$ref: "#/components/schemas/Documentation"
37143716
examples:
37153717
updated:
3716-
externalDataValue: ./examples/content.json
3717-
externalSerializedValue: ./examples/updated.xml
3718+
dataValue: {
3719+
"content": "<html><head><title>Awesome Docs</title></head><body></body><html>"
3720+
}
3721+
externalValue: ./examples/updated.xml
37183722
responses:
37193723
"201": {}
37203724
components:
@@ -3733,11 +3737,6 @@ components:
37333737

37343738
where `./examples/content.json` would be:
37353739

3736-
```json
3737-
{
3738-
"content": "<html><head><title>Awesome Docs</title></head><body></body><html>"
3739-
}
3740-
```
37413740

37423741
`./examples/stored.xml` would be:
37433742

@@ -3806,7 +3805,7 @@ application/xml:
38063805
},
38073806
null
38083807
]
3809-
externalSerializedValue: ./examples/OneTwoThree.xml
3808+
externalValue: ./examples/OneTwoThree.xml
38103809
```
38113810

38123811
Where `./examples/OneTwoThree.xml` would be:
@@ -3845,7 +3844,7 @@ application/xml:
38453844
42,
38463845
"Some postamble text."
38473846
]
3848-
externalSerializedValue: ./examples/Report.xml
3847+
externalValue: ./examples/Report.xml
38493848
```
38503849

38513850
Where `./examples/Report.xml` would be:
@@ -3894,14 +3893,14 @@ examples:
38943893
"description": "Thing",
38953894
"related": null
38963895
}
3897-
externalSerializedValue: ./examples/productWithNulls.xml
3896+
externalValue: ./examples/productWithNulls.xml
38983897
productNoNulls:
38993898
dataValue: {
39003899
"count": 42,
39013900
"description: "Thing"
39023901
"related": {}
39033902
}
3904-
externalSerializedValue: ./examples/productNoNulls.xml
3903+
externalValue: ./examples/productNoNulls.xml
39053904
```
39063905

39073906
Where `./examples/productWithNulls.xml` would be:

0 commit comments

Comments
 (0)