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: upgrading/v3.0-to-v3.1.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ While this version change may appear minor, OpenAPI 3.1 does introduce some brea
29
29
30
30
## JSON Schema Alignment
31
31
32
-
OpenAPI 3.1 achieves full compatibility with JSON Schema Draft 2020-12. Previously, OpenAPI used a modified subset of JSON Schema that added some features while removing others, creating confusion in the community.
32
+
OpenAPI 3.1 achieves full compatibility with [JSON Schema Draft 2020-12](https://www.ietf.org/archive/id/draft-bhutton-json-schema-01.html). Previously, OpenAPI used a modified subset of JSON Schema that added some features while removing others, creating confusion in the community.
33
33
34
34
### Background
35
35
@@ -182,7 +182,7 @@ The `contentEncoding` keyword supports all encodings defined in [RFC4648](https:
182
182
183
183
### $schema declarations
184
184
185
-
OpenAPI 3.1 supports the `$schema` keyword, which explicitly declares the JSON Schema dialect in use. This prevents ambiguity for tools processing multiple schema versions.
185
+
OpenAPI 3.1 supports the `$schema` keyword within [Schema Objects](https://spec.openapis.org/oas/v3.1.html#schema-object), which explicitly declares the JSON Schema dialect in use. This prevents ambiguity for tools processing multiple schema versions.
186
186
187
187
```json
188
188
{
@@ -198,7 +198,7 @@ This explicit declaration eliminates the need for tools to infer schema versions
198
198
199
199
- [ ] Update `openapi` version to `3.1.1`
200
200
- [ ] Replace `nullable: true` with type arrays (`type: ["string", "null"]`)
201
-
- [ ] Update `exclusiveMinimum`/`exclusiveMaximum` from boolean modifiers to direct values
201
+
- [ ] Update `exclusiveMinimum`/`exclusiveMaximum` from boolean modifiers to direct values and remove sibling `minimum/maximum`
202
202
- [ ] Change schema `example` to `examples` (as an array)
203
203
- [ ] Update file upload descriptions to use `contentEncoding`/`contentMediaType`
0 commit comments