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
+16-17Lines changed: 16 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,43 +9,43 @@ What's coming up? Look at `src/oas.md` on the relevant development branch for fu
9
9
- 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
10
11
11
- Tags
12
-
- new summary field to match other things
13
-
- parent field to allow hierarchy
14
-
- kind to allow multiple categories of tag
15
-
- a registry for some common categories (but any value can be used)
12
+
- 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
+
-`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
+
-`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
+
- a [registry](https://spec.openapis.org/registry/tag-kind/index.html) to establish conventions for values used in `kind`.
16
16
17
17
- Security:
18
18
- 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
19
- additional security scheme field: `oauth2MetadataUrl` URL for auth server metadata
20
-
- additional field to mark security schemes as deprecated (so don't use it for new stuff, but maybe still supported/valid)
21
-
-can reference a security scheme by URI rather than needing it declared in components.
20
+
- additional `deprecated`field for security schemes (indicating that the scheme may still be supported, but that it should not be used)
21
+
-ability to reference a security scheme by URI rather than needing it declared in components.
22
22
23
23
- Servers:
24
24
- clarify that server URLs should not include fragment or query.
25
-
- support new`name` field alongside description, url and variables
26
-
- formal path templating support for variable substitution in server urls
25
+
- support new`name` field alongside `description`, `url` and `variables`.
26
+
- formal path templating support for variable substitution in server urls.
27
27
28
28
- Discriminator
29
-
- use discriminator to hint which anyOf or oneOf is expected (existing functionality)
30
-
-discriminator `propertyName` MUST be defined but the named field can be optional (previously was required)
31
-
-use `mapping` to link the discriminator property value to the Schema name if they aren't an exact match (existing functionality)
32
-
-new field: `defaultMapping`says which schema to use if the `propertyName` is not set, or if the value is unrecognized
29
+
-no change from previous versions: use `discriminator` to hint which entry in `anyOf` or `oneOf` is expected.
30
+
-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
+
- the discriminator `propertyName` can now be an optional field.
32
+
-additional `defaultMapping`field to indicate which schema to use if the `propertyName` is not set, or if the value is unrecognized.
33
33
34
34
-**ABNF** (Augmented Backus–Naur Form) formalised for path templating, server variables, and runtime expressions in the Links object.
35
35
36
-
Improvements for APIs using XML as a content format:
36
+
-Improvements for APIs using XML as a content format:
37
37
- XML namespaces can be IRIs (rather than URIs)
38
38
- Explanation and example on how to handle `null` in XML
39
39
40
40
- Sequential media types:
41
-
- 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.
41
+
- 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
42
- Responses can be a repeating data structure, and are treated as if they are an array of schema objects.
43
-
- Use itemSchema in a mediatype entry to describe each item
43
+
- Use `itemSchema` in a mediatype entry to describe each item
44
44
- Related: a new media types registry is published to give more context for each of the media types
45
45
- Also a "Complete vs Streaming Content" section for guidance on streaming binary payloads
46
46
47
47
Minor edits that are worth a mention:
48
-
-Description field for responses are now optional (they used to be required but they could be empty)
48
+
-The `description` field for responses are now optional (they used to be required but they could be empty)
49
49
- Streamlined to YAML examples (unless something specific to another format) to try to make it easier to follow
50
50
-`allowReserved` is now supported for any parameter or header, regardless of `in` location
51
51
@@ -62,7 +62,6 @@ Minor edits that are worth a mention:
62
62
- Clarify that Request Body Objects need to specify at least one media type to be meaningful
63
63
- How to more clearly indicate that responses will not have a body
64
64
65
-
66
65
## 3.1 Updates
67
66
68
67
Version 3.1.2 has no material changes but does contain editorial fixes.
0 commit comments