Skip to content

Commit 4d0efaf

Browse files
lornajaneralfhandl
andauthored
Apply suggestions from code review
Co-authored-by: Ralf Handl <[email protected]>
1 parent de68530 commit 4d0efaf

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

upgrading/v3.0-to-v3.1.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ While this version change may appear minor, OpenAPI 3.1 does introduce some brea
2929

3030
## JSON Schema Alignment
3131

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.
3333

3434
### Background
3535

@@ -182,7 +182,7 @@ The `contentEncoding` keyword supports all encodings defined in [RFC4648](https:
182182

183183
### $schema declarations
184184

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.
186186

187187
```json
188188
{
@@ -198,7 +198,7 @@ This explicit declaration eliminates the need for tools to infer schema versions
198198

199199
- [ ] Update `openapi` version to `3.1.1`
200200
- [ ] 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`
202202
- [ ] Change schema `example` to `examples` (as an array)
203203
- [ ] Update file upload descriptions to use `contentEncoding`/`contentMediaType`
204204
- [ ] Consider adding `$schema` declarations for better tool compatibility
@@ -208,7 +208,7 @@ This explicit declaration eliminates the need for tools to infer schema versions
208208

209209
## Tools and Resources
210210

211-
- [OpenAPI 3.1 Specification](https://spec.openapis.org/oas/v3.1.0)
211+
- [OpenAPI 3.1 Specification](https://spec.openapis.org/oas/v3.1)
212212
- [JSON Schema Draft 2020-12](https://json-schema.org/draft/2020-12/schema)
213213
- [swagger2openapi](https://github.com/Mermade/oas-kit/blob/master/packages/swagger2openapi/README.md) for upgrading from Swagger 2.0
214214
- OpenAPI 3.1 compatible validators and tooling

upgrading/v3.1-to-v3.2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ Consider adopting new features incrementally:
180180

181181
## Tools and Resources
182182

183-
- [OpenAPI 3.2 Specification](https://spec.openapis.org/oas/latest) (when available)
183+
- [OpenAPI 3.2 Specification](https://spec.openapis.org/oas/v3.2) (when available)
184184
- [The OpenAPI Specification Explained](../specification/) - Updated with 3.2 features
185185
- [Media Types Registry](https://spec.openapis.org/registry/media-type/index.html)
186186
- [Tag Kind Registry](https://spec.openapis.org/registry/tag-kind/index.html)

0 commit comments

Comments
 (0)