Skip to content

Commit 8733e80

Browse files
authored
Merge pull request #4081 from handrews/fixes-304
Minor param serialization and wording fixes
2 parents 95ceb03 + af8f02c commit 8733e80

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

versions/3.0.4.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3792,7 +3792,7 @@ security:
37923792

37933793
See [Resolving Implicit Connections](#resolving-implicit-connections) for more information.
37943794

3795-
First, our [entry document](#openapi-description-structure) is where parsing begins. It defines the `MySecurity` security scheme to be JWT-based, and it defines a Path Item as a reference to a component in another document:
3795+
First, the [entry document](#openapi-description-structure) is where parsing begins. It defines the `MySecurity` security scheme to be JWT-based, and it defines a Path Item as a reference to a component in another document:
37963796

37973797
```HTTP
37983798
GET /api/description/openapi HTTP/1.1
@@ -3835,7 +3835,7 @@ paths:
38353835
$ref: 'other#/components/pathItems/Foo'
38363836
```
38373837

3838-
Next, we have our referenced document, `other`. The fact that we don't use file extensions gives the client the flexibility to choose an acceptable format on a resource-by-resource basis, assuming both representations are available:
3838+
This entry document references another document, `other`, without using a file extension. This gives the client the flexibility to choose an acceptable format on a resource-by-resource basis, assuming both representations are available:
38393839

38403840
```HTTP
38413841
GET /api/description/other HTTP/1.1
@@ -3988,11 +3988,12 @@ Requiring input as pre-formatted, schema-validated strings also improves round-t
39883988

39893989
## Appendix C: Using RFC6570-Based Serialization
39903990

3991-
Serialization is defined in terms of [RFC6570](https://www.rfc-editor.org/rfc/rfc6570) URI Templates in two scenarios:
3991+
Serialization is defined in terms of [RFC6570](https://www.rfc-editor.org/rfc/rfc6570) URI Templates in three scenarios:
39923992

39933993
| Object | Condition |
39943994
| ---- | ---- |
39953995
| [Parameter Object](#parameter-object) | When `schema` is present |
3996+
| [Header Object](#header-object) | When `schema` is present |
39963997
| [Encoding Object](#encoding-object) | When encoding for `application/x-www-form-urlencoded` and any of `style`, `explode`, or `allowReserved` are used |
39973998

39983999
Implementations of this specification MAY use an implementation of RFC6570 to perform variable expansion, however, some caveats apply.
@@ -4032,10 +4033,10 @@ parameters:
40324033
type: string
40334034
```
40344035

4035-
This example is equivalent to RFC6570's `{?foo*,bar}`, and **_NOT_** `{?foo*}{&bar}`. The latter is problematic because if `foo` is not defined, the result will be an invalid URI.
4036+
This example is equivalent to RFC6570's `{?foo*,bar}`, and **NOT** `{?foo*}{&bar}`. The latter is problematic because if `foo` is not defined, the result will be an invalid URI.
40364037
The `&` prefix operator has no equivalent in the Parameter Object.
40374038

4038-
Note that RFC6570 does not specify behavior for compound values beyond the single level addressed by `explode`. The results of using objects or arrays where no behavior is clearly specified for them is implementation-defined.
4039+
Note that RFC6570 does not specify behavior for compound values beyond the single level addressed by `explode`. The result of using objects or arrays where no behavior is clearly specified for them is implementation-defined.
40394040

40404041
### Delimiters in Parameter Values
40414042

@@ -4126,6 +4127,7 @@ parameters:
41264127
- name: words
41274128
in: query
41284129
style: spaceDelimited
4130+
explode: false
41294131
schema:
41304132
type: array
41314133
items:
@@ -4333,7 +4335,7 @@ However, care must be taken to use `form-urlencoded` decoding if `+` represents
43334335

43344336
### Percent-Encoding and Illegal or Reserved Delimiters
43354337

4336-
The `[`, `]`, `|`, and space characters, which are used as delimiters for the `deepObject`, `pipeDelimited`, and `spaceDelimited` styles, respectively, all MUST be percent-encoded to comply with[[RFC3986]].
4338+
The `[`, `]`, `|`, and space characters, which are used as delimiters for the `deepObject`, `pipeDelimited`, and `spaceDelimited` styles, respectively, all MUST be percent-encoded to comply with [[RFC3986]].
43374339
This requires users to pre-encode the character(s) in some other way in parameter names and values to distinguish them from the delimiter usage when using one of these styles.
43384340

43394341
The space character is always illegal and encoded in some way by all implementations of all versions of the relevant standards.

0 commit comments

Comments
 (0)