Skip to content

Commit e8cc875

Browse files
committed
Add style: cookie and other recent changes
1 parent 403a010 commit e8cc875

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

draft-release-notes.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,10 +161,15 @@ There is also a new Media Types Registry, to provide further resources for worki
161161

162162
- Additional parameter location `querystring`, to allow parsing the entire query string as a single field similar to the way a request body is handled, using the `content` field. Useful for complex or unconventional query data. Mutually exclusive with the `query` field.
163163
- Parameters can therefore be `in` the `querystring` as an alternative to the existing `header`, `cookie`, `query` and `path` values.
164-
- `allowReserved` field is now permitted on headers and on parameters with any value of `in`.
164+
- `allowReserved` field is now permitted on headers and on parameters with any value of `in`, and applies where the combination of `in` and `style` automatically percent-encode the value.
165165
- Remove incorrect mention of Reference Object in the header `schema` field. The JSONSchema ref would be the correct thing to use in this context.
166166
- The `examples` (and older `example`) field is now supported with `content`.
167167

168+
### Specific `style` option for cookies
169+
170+
- Additional `style` option `cookie` for content in a cookie, which uses semicolon as a separator and does not encode data values.
171+
The `form` style is a close fit, but you may wish to switch to `cookie` for more correct description.
172+
168173
#### Multipart media types
169174

170175
Multipart media types are much better supported in OpenAPI 3.2.
@@ -336,8 +341,9 @@ Particularly if you are building OpenAPI tooling, these sections give much bette
336341

337342
## 3.1 Updates
338343

339-
Version 3.1.2 has no material changes but does contain editorial fixes.
344+
Version 3.1.2 has no material changes but does contain editorial fixes, additional examples, and clarifications.
340345

346+
- Clarify that `$ref` in a Schema Object is a JSONSchema `$ref` keyword.
341347
- Detailed explanation of percent-encoding and -decoding, updated examples and references to match, including the Style Examples table.
342348
- Better explanation and examples for using Encoding and Serialization, and a note not to apply percent-encoding to headers.
343349
- Clarify that Request Body Objects need to specify at least one media type to be meaningful.

0 commit comments

Comments
 (0)