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
Copy file name to clipboardExpand all lines: draft-release-notes.md
+27-11Lines changed: 27 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,9 +12,12 @@ A summary of the biggest changes.
12
12
13
13
#### Nested, multipurpose tags
14
14
15
-
- New `summary` field to allow short descriptions, used when displaying lists of tags. If you use the `x-displayName` extension, you can now use `summary` instead.
15
+
Tags get an upgrade, with some new fields to make them more useful and reflect some of the features that need extensions to achieve today:
16
+
17
+
-`summary` field to allow short descriptions, used when displaying lists of tags. If you use the `x-displayName` extension, you can now use `summary` instead.
16
18
-`parent` field to point to the tag that this tag is nested under. If you use `x-tagGroups`, adjust to use a tags hierarchy.
17
-
-`kind` to allow multiple categories of tag. The `kind` field is free-form text, however there are some expected/conventional values such as `nav` (in line with the most common current usage as grouping for documentation output).
19
+
-`kind` field to allow a tag to be classified into a category such as navigation, or audience.
20
+
The `kind` field is free-form text, however there are some expected/conventional values such as `nav` (in line with the most common current usage as grouping for documentation output).
18
21
- A [registry](https://spec.openapis.org/registry/tag-kind/index.html) to establish conventions for values used in `kind`.
19
22
20
23
#### Support additional HTTP methods
@@ -35,6 +38,8 @@ A summary of the biggest changes.
35
38
36
39
OpenAPI specification v3.2 brings consistent, modular, and extensible media type and parameter support, while also expanding the set of media types supported in response to both emerging and legacy use cases. In addition, the ambiguity regarding how to present examples in a variety of complex scenarios is reduced.
37
40
41
+
There is also a new Media Types Registry, to provide further resources for working with different media types.
42
+
38
43
#### Support for sequential media types
39
44
40
45
- Support for sequential media types such as `text/event-stream` for server-sent events (SSE) and `multipart/mixed`, `application/jsonl`, `application/json-seq` and others for sequential data.
@@ -53,7 +58,15 @@ OpenAPI specification v3.2 brings consistent, modular, and extensible media type
53
58
54
59
#### Multipart media types
55
60
56
-
**TODO** this section with the additional items fields and examples.
61
+
Multipart media types are much better supported in OpenAPI 3.2.
62
+
63
+
- New `itemSchema` field, for the schema that describes each of the items in a sequential media type.
64
+
These sequential types may not be received or parsed in one go, so the `itemSchema` field supports ongoing parsing.
65
+
- New fields `prefixEncoding` and `itemEncoding` can be used instead of `encoding` for multipart media types.
66
+
- Use `prefixEncoding` with an array of positional encoding information where the position of each item in the content is known.
67
+
- The `itemEncoding` is a single encoding entry that is used for information about multiple items.
68
+
- The specification also contains examples of sequential JSON and Server-Sent events that show these fields in use.
69
+
- Nested content types are supported to at least one level of nesting.
57
70
58
71
#### Improvements for APIs using XML as a content format
59
72
@@ -65,7 +78,7 @@ OpenAPI specification v3.2 brings consistent, modular, and extensible media type
65
78
- Explanation and examples for many use cases including handling `null`, handling arrays, replacing the name, and handling ordered elements.
66
79
- Clarify that the root schema of an XML object should use the component name.
67
80
68
-
#### Show examples in both structured and serialized forms
81
+
#### Describe examples in both structured and serialized forms
69
82
70
83
- The Example Object (used in `examples` fields) gets two new fields: `dataValue` and `serializedValue`.
71
84
-`dataValue` describes the example in structured format.
@@ -189,7 +202,6 @@ Next time you're wondering if you can do `/api/v{version}/users/{user-id}` in a
189
202
190
203
#### Minor updates that are worth a mention
191
204
192
-
- Streamlined to YAML examples (unless something specific to another format) to try to make it easier to follow.
193
205
- Non-Schema examples no longer "override" Schema examples; tools are free to use the most appropriate example for any given use case.
194
206
- A new key `mediaTypes` is supported under `components` to support re-use of Media Type Objects.
195
207
@@ -203,20 +215,24 @@ Next time you're wondering if you can do `/api/v{version}/users/{user-id}` in a
203
215
#### Editorial changes
204
216
205
217
- Extensive additions around media types, encoding, sequential media types, SSE examples, working with binary data.
206
-
- Better explanation and examples for using Encoding.
218
+
- Streamlined to YAML examples (unless something specific to another format) to try to make it easier to follow.
219
+
- Better explanation and examples for using Encoding and Serialization, and a note not to apply percent-encoding to headers.
207
220
- Clarify that Request Body Objects need to specify at least one media type to be meaningful.
208
221
- How to more clearly indicate that responses will not have a body.
209
222
- Explanation and examples of headers including `Link` and `Set-Cookie`.
210
-
- No change but extensive additional notes on parsing and serializing JSON and non-JSON data formats.
211
-
Particularly if you are building OpenAPI tooling, this section gives much better guidance on some of those tricky edge cases.
223
+
- Detailed explanation of percent-encoding and -decoding, updated examples and references to match, including the Style Examples table.
224
+
- Extensive additional notes on parsing and serializing JSON and non-JSON data formats.
225
+
226
+
Particularly if you are building OpenAPI tooling, these sections give much better guidance on some of those tricky edge cases.
212
227
213
228
## 3.1 Updates
214
229
215
230
Version 3.1.2 has no material changes but does contain editorial fixes.
216
231
217
-
- Better explanation and examples for using Encoding.
218
-
- Clarify that Request Body Objects need to specify at least one media type to be meaningful
219
-
- How to more clearly indicate that no response will have a body
232
+
- Detailed explanation of percent-encoding and -decoding, updated examples and references to match, including the Style Examples table.
233
+
- Better explanation and examples for using Encoding and Serialization, and a note not to apply percent-encoding to headers.
234
+
- Clarify that Request Body Objects need to specify at least one media type to be meaningful.
235
+
- How to more clearly indicate that no response will have a body.
220
236
- How to handle `null` in XML as an advisory note; since the functionality cannot be changed it is implementation-defined for 3.1 tooling.
221
237
- Clarify that the root schema of an XML object should use the component name.
0 commit comments