Officially Clarified

What's Changed

• Support OAS 3.1.2 by @mattpolzin in #426

Full Changelog: 4.1.0...4.2.0

Officially Clarified (backport to 3.x)

What's Changed

• Support OAS 3.1.2 by @mattpolzin in #427

⚠️ Heads up

• From a Swift standpoint, adding OAS v3_1_2 is a breaking change if you have any switch statements that match on the version enumeration and don't allow for future additions to the enumeration. This is regrettable but it is not practical to release a new major version of OpenAPIKit when the OAS standard introduces clarification patch versions like is the case this time.

Full Changelog: 3.7.1...3.8.0

Send 'em All

What's Changed

• Declare more types Sendable (#422)

Full Changelog: 4.0.1...4.1.0

Valid Concern (backport to 3.x)

What's Changed

• Backport of #420 (#421)

This release adds a new validation that fixes the already-described validation that all references in the document can be found in the Components Object.

Full Changelog: 3.7.0...3.7.1

Valid Concern

What's Changed

• Add new default-on builtin validation that all callbacks references can befound in the components object (#420)

This new validation fixes the already-described validation that all references in the document can be found in the Components Object.

Full Changelog: 4.0.0...4.0.1

Concurrent Externality

Firstly and most importantly, read over the 3.x -> 4.0.0 migration guide when upgrading to this major version of OpenAPIKit.

High Level Overview

Version 4 of OpenAPIKit continues to support the OpenAPI Specification at both versions 3.0.x and 3.1.x via separate modules. You can find OAS 3.0.x support in the OpenAPIKit30 module and OAS 3.1.x support in the OpenAPIKit module.

OpenAPIKit has dropped support for some older versions of Swift. Swift 5.8+ is now required.

OpenAPIKit v4.0.0 adds support for dereferencing external references; now OpenAPI documents that are spread across multiple files with OpenAPI references between them can be loaded. This new support does require a bit of extra work on the part of the code using OpenAPIKit -- more on that in the README.

This release also adds Sendable conformances throughout so that OpenAPIKit types can be used in modern Swift concurrency code. The aforementioned external dereferencing is done in an async compatible way as well because loading in a large OpenAPI document defined by many files can potentially benefit greatly from concurrency.

Full Changelog Since Latest Release Candidate: 4.0.0-rc.5...4.0.0
Full Changelog Since Last Major Release: 3.7.0...4.0.0

Typical Content (4)

What's Changed

• Reduce number of protocol conformance warnings (#412)
• add prefixItems to array by @true-false-maybe (#414)
• add more ContentType's by @true-false-maybe (#416)

Full Changelog: 4.0.0-rc.4...4.0.0-rc.5

Typical Content

What's Changed

• add more ContentType's by @true-false-maybe in #416

Full Changelog: 3.6.0...3.7.0

Prefixed with love

What's Changed

• add prefixItems to array by @true-false-maybe in #414

New Contributors

• @true-false-maybe made their first contribution in #414

Full Changelog: 3.5.2...3.6.0

AllOf the extensions (4)

What's Changed

• allow Yams 6.x (#410)
• Support vendor extensions in anyOf allOf oneOf for OAS 3.1 by @simonbility in (#409, #411)
• Update inconsistency error to be better suited to general use (#408)

Breaking

The InconsistencyError type has been renamed to GenericError. Its string description has been rephrased from "Inconsistency encountered..." to "Problem encountered..."

Full Changelog: 4.0.0-rc.3...4.0.0-rc.4