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.0.4.md
+7-5Lines changed: 7 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -3789,7 +3789,7 @@ security:
3789
3789
3790
3790
See [Resolving Implicit Connections](#resolving-implicit-connections) for more information.
3791
3791
3792
-
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:
3792
+
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:
3793
3793
3794
3794
```HTTP
3795
3795
GET /api/description/openapi HTTP/1.1
@@ -3832,7 +3832,7 @@ paths:
3832
3832
$ref: 'other#/components/pathItems/Foo'
3833
3833
```
3834
3834
3835
-
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:
3835
+
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:
3836
3836
3837
3837
```HTTP
3838
3838
GET /api/description/other HTTP/1.1
@@ -3985,11 +3985,12 @@ Requiring input as pre-formatted, schema-validated strings also improves round-t
3985
3985
3986
3986
## Appendix C: Using RFC6570 Implementations
3987
3987
3988
-
Serialization is defined in terms of [RFC6570](https://www.rfc-editor.org/rfc/rfc6570) URI Templates in two scenarios:
3988
+
Serialization is defined in terms of [RFC6570](https://www.rfc-editor.org/rfc/rfc6570) URI Templates in three scenarios:
3989
3989
3990
3990
| Object | Condition |
3991
3991
| ---- | ---- |
3992
3992
| [Parameter Object](#parameter-object) | When `schema` is present |
3993
+
| [Header Object](#header-object) | When `schema` is present |
3993
3994
| [Encoding Object](#encoding-object) | When encoding for `application/x-www-form-urlencoded` and any of `style`, `explode`, or `allowReserved` are used |
3994
3995
3995
3996
Implementations of this specification MAY use an implementation of RFC6570 to perform variable expansion, however, some caveats apply.
@@ -4032,7 +4033,7 @@ parameters:
4032
4033
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.
4033
4034
The `&` prefix operator has no equivalent in the Parameter Object.
4034
4035
4035
-
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.
4036
+
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.
4036
4037
4037
4038
### Non-RFC6570 Field Values and Combinations
4038
4039
@@ -4114,6 +4115,7 @@ parameters:
4114
4115
- name: words
4115
4116
in: query
4116
4117
style: spaceDelimited
4118
+
explode: false
4117
4119
schema:
4118
4120
type: array
4119
4121
items:
@@ -4321,7 +4323,7 @@ However, care must be taken to use `form-urlencoded` decoding if `+` represents
4321
4323
4322
4324
### Percent-Encoding and Illegal or Reserved Delimiters
4323
4325
4324
-
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]].
4326
+
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]].
4325
4327
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.
4326
4328
4327
4329
The space character is always illegal and encoded in some way by all implementations of all versions of the relevant standards.
0 commit comments