You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Explicitly set `explode: false` in an example as the default
with `style: form` is `explode: true`; the `explode: true`
example was also left explicit to reduce confusion.
* Tidy up overly conversational (e.g. "our document") language
that I'd meant to revisit but forgot about.
* Include the Header Object as one of the places where the
`style` keyword is used (even if it is the simplest case)
* Minor grammar fix.
* Fix a missing space before an RFC reference.
Copy file name to clipboardExpand all lines: versions/3.1.1.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3990,7 +3990,7 @@ security:
3990
3990
3991
3991
See [Resolving Implicit Connections](#resolving-implicit-connections) for more information.
3992
3992
3993
-
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:
3993
+
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:
3994
3994
3995
3995
```HTTP
3996
3996
GET /api/description/openapi HTTP/1.1
@@ -4033,7 +4033,7 @@ paths:
4033
4033
$ref: 'other#/components/pathItems/Foo'
4034
4034
```
4035
4035
4036
-
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:
4036
+
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:
4037
4037
4038
4038
```HTTP
4039
4039
GET /api/description/other HTTP/1.1
@@ -4190,11 +4190,12 @@ Requiring input as pre-formatted, schema-validated strings also improves round-t
4190
4190
4191
4191
## Appendix C: Using RFC6570-Based Serialization
4192
4192
4193
-
Serialization is defined in terms of [RFC6570](https://www.rfc-editor.org/rfc/rfc6570) URI Templates in two scenarios:
4193
+
Serialization is defined in terms of [RFC6570](https://www.rfc-editor.org/rfc/rfc6570) URI Templates in three scenarios:
4194
4194
4195
4195
| Object | Condition |
4196
4196
| ---- | ---- |
4197
4197
| [Parameter Object](#parameter-object) | When `schema` is present |
4198
+
| [Header Object](#header-object) | When `schema` is present |
4198
4199
| [Encoding Object](#encoding-object) | When encoding for `application/x-www-form-urlencoded` and any of `style`, `explode`, or `allowReserved` are used |
4199
4200
4200
4201
Implementations of this specification MAY use an implementation of RFC6570 to perform variable expansion, however, some caveats apply.
@@ -4241,7 +4242,7 @@ parameters:
4241
4242
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.
4242
4243
The `&` prefix operator has no equivalent in the Parameter Object.
4243
4244
4244
-
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.
4245
+
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.
4245
4246
4246
4247
### Delimiters in Parameter Values
4247
4248
@@ -4332,6 +4333,7 @@ parameters:
4332
4333
- name: words
4333
4334
in: query
4334
4335
style: spaceDelimited
4336
+
explode: false
4335
4337
schema:
4336
4338
type: array
4337
4339
items:
@@ -4540,7 +4542,7 @@ However, care must be taken to use `form-urlencoded` decoding if `+` represents
4540
4542
4541
4543
### Percent-Encoding and Illegal or Reserved Delimiters
4542
4544
4543
-
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]].
4545
+
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]].
4544
4546
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.
4545
4547
4546
4548
The space character is always illegal and encoded in some way by all implementations of all versions of the relevant standards.
0 commit comments