Skip to content

Commit 9104a7c

Browse files
authored
Merge pull request #5170 from valerii15298/patch-6
2 parents 979f403 + 73234f9 commit 9104a7c

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

src/oas.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -925,7 +925,7 @@ The following table shows serialized examples, as would be shown with the `seria
925925
| simple | true | _empty_ | blue | blue,black,brown | R=100,G=200,B=150 |
926926
| form | false | <span style="white-space: nowrap;">color=</span> | <span style="white-space: nowrap;">color=blue</span> | <span style="white-space: nowrap;">color=blue,black,brown</span> | <span style="white-space: nowrap;">color=R,100,G,200,B,150</span> |
927927
| form | true | <span style="white-space: nowrap;">color=</span> | <span style="white-space: nowrap;">color=blue</span> | <span style="white-space: nowrap;">color=blue&color=black&color=brown</span> | <span style="white-space: nowrap;">R=100&G=200&B=150</span> |
928-
| spaceDelimited</span> | false | _n/a_ | _n/a_ | <span style="white-space: nowrap;">color=blue%20black%20brown</span> | <span style="white-space: nowrap;">color=R%20100%20G%20200%20B%20150</span> |
928+
| spaceDelimited | false | _n/a_ | _n/a_ | <span style="white-space: nowrap;">color=blue%20black%20brown</span> | <span style="white-space: nowrap;">color=R%20100%20G%20200%20B%20150</span> |
929929
| spaceDelimited | true | _n/a_ | _n/a_ | _n/a_ | _n/a_ |
930930
| pipeDelimited | false | _n/a_ | _n/a_ | <span style="white-space: nowrap;">color=blue%7Cblack%7Cbrown</span> | <span style="white-space: nowrap;">color=R%7C100%7CG%7C200%7CB%7C150</span> |
931931
| pipeDelimited | true | _n/a_ | _n/a_ | _n/a_ | _n/a_ |
@@ -935,7 +935,7 @@ The following table shows serialized examples, as would be shown with the `seria
935935

936936
#### Extending Support for Querystring Formats
937937

938-
Many frameworks define query string syntax for complex values, such as appending array indices to parameter names or indicating multiple levels of of nested objects, which go well beyond the capabilities of the `deepObject` style.
938+
Many frameworks define query string syntax for complex values, such as appending array indices to parameter names or indicating multiple levels of nested objects, which go well beyond the capabilities of the `deepObject` style.
939939

940940
As these are not standards, and often contradict each other, the OAS does not attempt to support them directly.
941941
Two avenues are available for supporting such formats with `in: "querystring"`:
@@ -1070,7 +1070,7 @@ examples:
10701070
dataValue:
10711071
page: 4
10721072
pageSize: 50
1073-
serializeValue: page=4&pageSize=50
1073+
serializedValue: page=4&pageSize=50
10741074
```
10751075
10761076
A complex parameter using `content` to define serialization, with multiple levels and types of examples shown to make the example usage options clear — note that `dataValue` is the same at both levels and does not need to be shown in both places in normal usage, but `serializedValue` is different:
@@ -2383,7 +2383,7 @@ The `serializedValue` and `externalValue` fields both MUST show the serialized f
23832383
For Media Type Objects, this is a document of the appropriate media type, with any Encoding Object effects applied.
23842384
For Parameter and Header Objects using `schema` and `style` rather than a Media Type Object, see [Style Examples](#style-examples) for what constitutes a serialized value.
23852385

2386-
##### Criteria for `serializedExample`
2386+
##### Criteria for `serializedValue`
23872387

23882388
A serialization can be represented as a valid Unicode string in `serializedValue` if any of the following are true of the serialization:
23892389

@@ -2858,7 +2858,7 @@ components:
28582858
In an HTTP message, the serialized example would look like:
28592859
28602860
```http
2861-
Set-Cookie: lang=en-US; Expires=Wed, 09 Jun 2021 10:18:14 GM
2861+
Set-Cookie: lang=en-US; Expires=Wed, 09 Jun 2021 10:18:14 GMT
28622862
Set-Cookie: foo=bar; Expires=Wed, 09 Jun 2021 10:18:14 GMT
28632863
Set-Cookie: urlSafeData=Hello%2C%20world%21
28642864
```
@@ -4449,8 +4449,7 @@ application/xml:
44494449
- Some text
44504450
- unit: cubits
44514451
value: 42
4452-
null
4453-
]
4452+
- null
44544453
externalValue: ./examples/OneTwoThree.xml
44554454
```
44564455

0 commit comments

Comments
 (0)