Skip to content

A Whole New World
Compare
Choose a tag to compare
@mattpolzin mattpolzin released this 05 Nov 00:45
· 72 commits to main since this release
3.0.0
ae98338

This release of OpenAPIKit brings support for OpenAPI 3.1 in addition to numerous other improvements and a fair number of breaking changes (hopefully all worth their weight!).

The biggest thing to know up front is that you will need to choose between one of two modules:
OpenAPIKit30 is a new module that continues to support the OAS 3.0 (OpenAPI 3.0 standard).
OpenAPIKit is the module that supports the OAS 3.1 (OpenAPI 3.1 standard).

I suggest migrating your code to the OpenAPIKit module if possible. You will need to do a bit more work (in some cases, not all) but this will set you up for the broadest support of OpenAPI Documents.

OpenAPIKit 3.0.0 ships with another module named OpenAPIKitCompat that allows you to turn an OpenAPIKit30.OpenAPI.Document into an OpenAPIKit.OpenAPI.Document (i.e. convert from OAS 3.0 to OAS 3.1). There is not yet support for converting from OAS 3.1 to OAS 3.0, though that is a desirable (if not planned) addition. There is documentation on how to use this conversion to write your code against the OpenAPIKit module but support loading in both OAS 3.0 and OAS 3.1 documents here.

There are two ways to explore the changes between OpenAPIKit v2.x and OpenAPIKit v3.0.0:

  1. Read the release notes for each v3.0.0 pre-release (best way to see new features added, most granular information on changes including breaking changes).
  2. Read the migration guide (fastest way to get yourself going against the new version).
Assets 2
Loading