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
+33-23Lines changed: 33 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,39 +4,49 @@ 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
-
8
7
-**ABNF** (Augmented Backus–Naur Form) for path templating, server variables, and runtime expressions in links object
9
8
- Sequential media types:
10
-
- 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.
11
-
- Responses can be a repeating data structure, and are treated as if they are an array of schema objects.
12
-
- Use itemSchema in a mediatype entry to describe each item
13
-
- Related: a new media types registry is published to give more context for each of the media types
14
-
- Also a "Complete vs Streaming Content" section for guidance on streaming binary payloads
9
+
- 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.
10
+
- Responses can be a repeating data structure, and are treated as if they are an array of schema objects.
11
+
- Use itemSchema in a mediatype entry to describe each item
12
+
- Related: a new media types registry is published to give more context for each of the media types
13
+
- Also a "Complete vs Streaming Content" section for guidance on streaming binary payloads
15
14
- Streamlined to YAML examples (unless something specific to another format) to try to make it easier to follow
16
15
- Servers:
17
-
- clarify that server URLs should not include fragment or query.
18
-
- support new`name` field alongside description, url and variables
19
-
- formal path templating support for variable substitution in server urls
16
+
- clarify that server URLs should not include fragment or query.
17
+
- support new`name` field alongside description, url and variables
18
+
- formal path templating support for variable substitution in server urls
20
19
- Methods:
21
-
- support the new `query` operation alongside get/post/put/delete/options/head/patch/trace
22
-
- 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`
20
+
- support the new `query` operation alongside get/post/put/delete/options/head/patch/trace
21
+
- 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`
23
22
- Extensive additions around media types, encoding, sequential media types, SSE examples, working with binary data,
24
23
- Description field for responses are now optional (they used to be required but they could be empty)
25
24
- Tags
26
-
- new summary field to match other things
27
-
- parent field to allow hierarchy
28
-
- kind to allow multiple categories of tag
25
+
- new summary field to match other things
26
+
- parent field to allow hierarchy
27
+
- kind to allow multiple categories of tag
28
+
- a registry for some common categories (but any value can be used)
29
29
- Discriminator - helps with API evolution (?)
30
-
- use discriminator to hint which anyOf or oneOf is expected
31
-
- discriminator propertyName MUST be defined but the field it points to MAY be optional - in which case a defaultMapping MUST be defined
32
-
- the mapping should be defined if the discriminator property value doesn't match the Schema name
33
-
- new field: `defaultMapping` means that if the discriminator field doesn't have a value, which mapping value to use
30
+
- use discriminator to hint which anyOf or oneOf is expected
31
+
- discriminator propertyName MUST be defined but the field it points to MAY be optional - in which case a defaultMapping MUST be defined
32
+
- the mapping should be defined if the discriminator property value doesn't match the Schema name
33
+
- new field: `defaultMapping` means that if the discriminator field doesn't have a value, which mapping value to use
34
34
- XML namespaces can be IRIs (rather than URIs)
35
35
- Security:
36
-
- 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`
37
-
- additional security scheme field: oauth2MetadataUrl URL for auth server metadata
38
-
- additional field to mark security schemes as deprecated (so don't use it for new stuff, but maybe still supported/valid)
39
-
- can reference a security scheme by URI rather than needing it declared in components.
36
+
- 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`
37
+
- additional security scheme field: oauth2MetadataUrl URL for auth server metadata
38
+
- additional field to mark security schemes as deprecated (so don't use it for new stuff, but maybe still supported/valid)
39
+
- can reference a security scheme by URI rather than needing it declared in components.
40
+
- In-place updates to existing specifications and standards that we reference:
41
+
- Update to https://www.ietf.org/archive/id/draft-bhutton-json-schema-01.html of JSON Schema Specification
42
+
- Update to https://www.ietf.org/archive/id/draft-bhutton-json-schema-validation-01.html of JSON Schema Validation Specification
43
+
- Use [RFC8529]((https://tools.ietf.org/html/rfc8259) for JSON
44
+
- Use [RFC9110]((https://tools.ietf.org/html/rfc9110) for HTTP
40
45
41
-
## 3.2 Updates
46
+
## 3.1 Updates
47
+
48
+
Version 3.1.2 has no material changes but does contain editorial fixes.
49
+
50
+
- Clarification that Example Objects can be used in Header Objects.
51
+
- Better explanation and examples for using Encoding.
0 commit comments