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
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -162,7 +162,7 @@ There is also a new Media Types Registry, to provide further resources for worki
162
162
- 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.
163
163
- Parameters can therefore be `in` the `querystring` as an alternative to the existing `header`, `cookie`, `query` and `path` values.
164
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.
165
-
- Remove incorrect mention of Reference Object in the header `schema` field. The JSONSchema ref would be the correct thing to use in this context.
165
+
- Remove incorrect mention of Reference Object in the header `schema` field. The JSON Schema `$ref` would be the correct thing to use in this context.
166
166
- The `examples` (and older `example`) field is now supported with `content`.
167
167
168
168
#### Specific `style` option for cookies
@@ -343,7 +343,7 @@ Particularly if you are building OpenAPI tooling, these sections give much bette
343
343
344
344
Version 3.1.2 has no material changes but does contain editorial fixes, additional examples, and clarifications.
345
345
346
-
- Clarify that `$ref` in a Schema Object is a JSONSchema `$ref` keyword.
346
+
- Clarify that `$ref` in a Schema Object is a JSON Schema `$ref` keyword.
347
347
- Detailed explanation of percent-encoding and -decoding, updated examples and references to match, including the Style Examples table.
348
348
- Better explanation and examples for using Encoding and Serialization, and a note not to apply percent-encoding to headers.
349
349
- Clarify that Request Body Objects need to specify at least one media type to be meaningful.
Copy file name to clipboardExpand all lines: summary-release-notes.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ What's coming up? Look at `src/oas.md` on the relevant development branch for fu
29
29
- Streaming support: sequential media types including SSE
30
30
31
31
- 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.
32
-
- Responses can be a repeating data structure, and are treated as if they are an array of schema objects.
32
+
- Responses can be a repeating data structure, and are treated as if they are an array of Schema Objects.
33
33
- Use `itemSchema` in a mediatype entry to describe each item.
34
34
- A media types registry is published to give more context for each of the media types.
35
35
@@ -57,9 +57,9 @@ What's coming up? Look at `src/oas.md` on the relevant development branch for fu
57
57
- The `xml` keyword can be used in any Schema Object.
58
58
- XML namespaces can be IRIs (rather than URIs).
59
59
- Explanation and examples for many use cases including handling `null`, handling arrays, replacing the name, and handling ordered elements.
60
-
- Clarify that the root schema of an XML object should use the component name.
60
+
- Clarify that the root schema of an XML Object should use the component name.
61
61
62
-
- Examples as either structured or serialised values
62
+
- Examples as either structured or serialized values
63
63
64
64
- The Example Object (used in `examples` fields) gets two new fields: `dataValue` and `serializedValue`.
65
65
-`dataValue` describes the example in structured format.
@@ -75,7 +75,7 @@ What's coming up? Look at `src/oas.md` on the relevant development branch for fu
75
75
- Additional `deprecated` field for security schemes (indicating that the scheme may still be supported, but that it should not be used).
76
76
- Ability to reference a security scheme by URI rather than declaring it in components.
77
77
78
-
- Improvements to the Servers object
78
+
- Improvements to the Server Object
79
79
80
80
- Clarify that server URLs should not include fragment or query.
81
81
- Support new `name` field alongside `description`, `url` and `variables`.
@@ -88,11 +88,11 @@ What's coming up? Look at `src/oas.md` on the relevant development branch for fu
88
88
89
89
- Templates with formal syntax
90
90
91
-
- The specification now includes **ABNF** (Augmented Backus–Naur Form) for path templating, server variables, and runtime expressions in the Links object.
91
+
- The specification now includes **ABNF** (Augmented Backus–Naur Form) for path templating, server variables, and runtime expressions in the Link Object.
92
92
93
-
- Flexible metadata fields in the Response object
93
+
- Flexible metadata fields in the Response Object
94
94
95
-
-`description` field for responses are now optional.
95
+
-`description` field for responses is now optional.
96
96
- Additional `summary` field for responses.
97
97
98
98
- Additional updates
@@ -122,7 +122,7 @@ What's coming up? Look at `src/oas.md` on the relevant development branch for fu
122
122
123
123
Version 3.1.2 has no material changes but does contain editorial fixes, additional examples, and clarifications.
124
124
125
-
- Clarify that `$ref` in a Schema Object is a JSONSchema`$ref` keyword.
125
+
- Clarify that `$ref` in a Schema Object is a JSON Schema`$ref` keyword.
126
126
- Detailed explanation of percent-encoding and -decoding, updated examples and references to match, including the Style Examples table.
127
127
- Better explanation and examples for using Encoding and Serialization, and a note not to apply percent-encoding to headers.
128
128
- Clarify that Request Body Objects need to specify at least one media type to be meaningful.
0 commit comments