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
+39-13Lines changed: 39 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,58 +4,83 @@ What's coming up? Look at `src/oas.md` on the relevant development branch for fu
4
4
5
5
## 3.2 Updates
6
6
7
-
- Methods:
7
+
### Methods
8
+
8
9
- support the new `query` operation alongside get/post/put/delete/options/head/patch/trace
9
10
- under an `additionalOperations` entry, use any other methods not listed as keys using the correct capitalization. e.g. do NOT add HEAD under this, use the existing sibling `head`
10
11
11
-
- Tags
12
+
### Tags
13
+
12
14
- 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.
13
15
-`parent` field to point to the tag that this tag is nested under. If you use `x-tagGroups`, adjust to use a tags hierarchy.
14
16
-`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).
15
17
- a [registry](https://spec.openapis.org/registry/tag-kind/index.html) to establish conventions for values used in `kind`.
16
18
17
-
- Security:
19
+
### Security
20
+
18
21
- Support for OAuth2 Device Authorization flow with additional `deviceAuthorization` field in the `flows` object and for the individual flow, a new field `deviceAuthorizationUrl` alongside `tokenUrl`
19
22
- additional security scheme field: `oauth2MetadataUrl` URL for auth server metadata
20
23
- additional `deprecated` field for security schemes (indicating that the scheme may still be supported, but that it should not be used)
21
24
- ability to reference a security scheme by URI rather than needing it declared in components.
22
25
23
-
- Servers:
26
+
### Servers
27
+
24
28
- clarify that server URLs should not include fragment or query.
25
29
- support new `name` field alongside `description`, `url` and `variables`.
26
30
- formal path templating support for variable substitution in server urls.
27
31
28
-
- Discriminator
32
+
### Discriminator
33
+
29
34
- no change from previous versions: use `discriminator` to hint which entry in `anyOf` or `oneOf` is expected.
30
35
- no change from previous versions: use `mapping` to link the discriminator property value to the Schema name if they aren't an exact match.
31
36
- the discriminator `propertyName` can now be an optional field.
32
37
- additional `defaultMapping` field to indicate which schema to use if the `propertyName` is not set, or if the value is unrecognized.
33
38
34
-
-**ABNF** (Augmented Backus–Naur Form) formalised for path templating, server variables, and runtime expressions in the Links object.
39
+
### Reference resolution
40
+
41
+
- additional top-level `$self` to be used as a base URI for resolving references in the OpenAPI description. If not present, the existing/earlier behaviour of using the retrieval URL as a base applies.
42
+
43
+
### **ABNF** (Augmented Backus–Naur Form) formalised for path templating, server variables, and runtime expressions in the Links object.
44
+
45
+
### Improvements for APIs using XML as a content format
35
46
36
-
- Improvements for APIs using XML as a content format:
37
47
- XML namespaces can be IRIs (rather than URIs)
38
48
- Explanation and example on how to handle `null` in XML
49
+
Clarify that the root schema of an XML object should use the component name.
50
+
51
+
### Sequential media type
39
52
40
-
- Sequential media types:
41
53
- Support for sequential mediatypes such as `text/event-stream` for server-sent events (SSE) and `application/jsonl`, `application/json-seq` and others for sequential data.
42
54
- Responses can be a repeating data structure, and are treated as if they are an array of schema objects.
43
55
- Use `itemSchema` in a mediatype entry to describe each item
44
56
- Related: a new media types registry is published to give more context for each of the media types
45
57
- Also a "Complete vs Streaming Content" section for guidance on streaming binary payloads
46
58
47
-
Minor edits that are worth a mention:
48
-
- The `description` field for responses are now optional (they used to be required but they could be empty)
59
+
### Parameters
60
+
61
+
- 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.
62
+
- parameters can therefore be `in` the `querystring` as an alternative to the existing `header`, `cookie`, `query` and `path` values.
63
+
-`allowReserved` field is now permitted on parameters with any value of `in` (however this many not be a Good Idea (TM) in some scenarios)
64
+
65
+
### Responses
66
+
67
+
-`description` field for responses are now optional (they used to be required but they could be empty)
68
+
- additional `summary` field for responses, useful when displaying responses in a list context
69
+
70
+
### Minor edits that are worth a mention:
71
+
49
72
- Streamlined to YAML examples (unless something specific to another format) to try to make it easier to follow
50
73
-`allowReserved` is now supported for any parameter or header, regardless of `in` location
51
74
52
-
- In-place updates to existing specifications and standards that we reference:
75
+
### In-place updates to existing specifications and standards that we reference:
76
+
53
77
- Update to https://www.ietf.org/archive/id/draft-bhutton-json-schema-01.html of JSON Schema Specification
54
78
- Update to https://www.ietf.org/archive/id/draft-bhutton-json-schema-validation-01.html of JSON Schema Validation Specification
55
79
- Use [RFC8529](https://tools.ietf.org/html/rfc8259) for JSON
56
80
- Use [RFC9110](https://tools.ietf.org/html/rfc9110) for HTTP
57
81
58
-
- Editorial changes:
82
+
### Editorial changes:
83
+
59
84
- Extensive additions around media types, encoding, sequential media types, SSE examples, working with binary data,
60
85
- Clarification that Example Objects can be used in Header Objects.
61
86
- Better explanation and examples for using Encoding.
@@ -70,6 +95,7 @@ Version 3.1.2 has no material changes but does contain editorial fixes.
70
95
- Better explanation and examples for using Encoding.
71
96
- Clarify that Request Body Objects need to specify at least one media type to be meaningful
72
97
- How to more clearly indicate that no response will have a body
73
-
- How to handle `null` in XML
98
+
- How to handle `null` in XML as an advisory note; since the functionality cannot be changed it is implementation-defined for 3.1 tooling.
99
+
- Clarify that the root schema of an XML object should use the component name.
74
100
75
101
<!-- vim: set ft=markdown tw=2 foldmethod=indent: -->
0 commit comments