Skip to content

Bump the default Document OAS version to 3.2.0 #459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattpolzin merged 2 commits into from
Dec 12, 2025
Merged

Bump the default Document OAS version to 3.2.0 #459

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e7589e
bump default open api standard version for new documents to 3.2.0
mattpolzin Dec 10, 2025
f464fa3
update migration guide
mattpolzin Dec 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Sources/OpenAPIKit/Document/Document.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ extension OpenAPI {
public let conditionalWarnings: [(any Condition, OpenAPI.Warning)]

public init(
openAPIVersion: Version = .v3_1_1,
openAPIVersion: Version = .v3_2_0,
selfURI: URL? = nil,
info: Info,
servers: [Server],
Expand Down
42 changes: 21 additions & 21 deletions Tests/OpenAPIKitTests/Document/DocumentTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,7 +520,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1"
"openapi" : "3.2.0"
}
"""
)
Expand All @@ -534,7 +534,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1",
"openapi" : "3.2.0",
"paths" : {

}
Expand Down Expand Up @@ -684,7 +684,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1",
"openapi" : "3.2.0",
"servers" : [
{
"url" : "http:\\/\\/google.com"
Expand All @@ -703,7 +703,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1",
"openapi" : "3.2.0",
"paths" : {

},
Expand Down Expand Up @@ -746,7 +746,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1"
"openapi" : "3.2.0"
}
"""
)
Expand All @@ -761,7 +761,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1",
"openapi" : "3.2.0",
"paths" : {

}
Expand Down Expand Up @@ -798,7 +798,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1",
"openapi" : "3.2.0",
"paths" : {
"\\/test" : {
"summary" : "hi"
Expand All @@ -817,7 +817,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1",
"openapi" : "3.2.0",
"paths" : {
"\\/test" : {
"summary" : "hi"
Expand Down Expand Up @@ -867,7 +867,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1",
"openapi" : "3.2.0",
"security" : [
{
"security" : [
Expand Down Expand Up @@ -897,7 +897,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1",
"openapi" : "3.2.0",
"paths" : {

},
Expand Down Expand Up @@ -944,7 +944,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1",
"openapi" : "3.2.0",
"tags" : [
{
"name" : "hi"
Expand All @@ -963,7 +963,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1",
"openapi" : "3.2.0",
"paths" : {

},
Expand Down Expand Up @@ -1009,7 +1009,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1"
"openapi" : "3.2.0"
}
"""
)
Expand All @@ -1026,7 +1026,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1",
"openapi" : "3.2.0",
"paths" : {

}
Expand Down Expand Up @@ -1068,7 +1068,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1",
"openapi" : "3.2.0",
"x-specialFeature" : [
"hello",
"world"
Expand All @@ -1089,7 +1089,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1",
"openapi" : "3.2.0",
"paths" : {

},
Expand Down Expand Up @@ -1129,7 +1129,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1",
"openapi" : "3.2.0",
"paths" : {

},
Expand Down Expand Up @@ -1181,7 +1181,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1",
"openapi" : "3.2.0",
"webhooks" : {
"webhook-test" : {
"delete" : {
Expand Down Expand Up @@ -1252,7 +1252,7 @@ extension DocumentTests {
"title": "API",
"version": "1.0"
},
"openapi": "3.1.1",
"openapi": "3.2.0",
"paths": {
},
"webhooks": {
Expand Down Expand Up @@ -1324,7 +1324,7 @@ extension DocumentTests {
"title" : "API",
"version" : "1.0"
},
"openapi" : "3.1.1",
"openapi" : "3.2.0",
"webhooks" : {
"webhook-test" : {
"delete" : {
Expand Down Expand Up @@ -1373,7 +1373,7 @@ extension DocumentTests {
"title": "API",
"version": "1.0"
},
"openapi": "3.1.1",
"openapi": "3.2.0",
"webhooks": {
"webhook-test": {
"delete": {
Expand Down
4 changes: 4 additions & 0 deletions documentation/migration_guides/v5_migration_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ statements will need to be updated.

If you use `v3_1_x(x: 2)` you should replace it with `v3_1_2`.

The default OAS version of a `Document` has been updated to `v3_2_0`. If you
need to produce a `v3_1_x` document, update your code to specify that version in
the `OpenAPI.Document` constructor.

### Content Types
The `application/x-yaml` media type is officially superseded by
`application/yaml`. OpenAPIKit will continue to support reading the
Expand Down