Thankfully the scope of the breaking changes is incredibly small, limited to the Schema Object, and achieves a much greater goal: full compatibility with modern JSON Schema. In a perfect world this would be all you need to do, but despite the minor version number, v3.1 does have some small breaking changes. If instead of `openapi: 3.0.3` you see `swagger: 2.0` then see if swagger2openapi can help you upgrade to v3.0 before continuing. If you’re ready to give it a try, let’s take a look at the changes you may, or may not, need to make in order to get onto OpenAPI v3.1.įirst things first, let’s change that version number! Open up your OpenAPI JSON or YAML file, and look for this line: openapi: 3.0.3 OpenAPI v3.1 brings a lot of great new functionality and improvements, and at some point in the near future you might find yourself wanting to upgrade.

If you’d like to donate to Phil’s charity of choice, please see Protect Earth which is reforesting the U.K. This post is authored by Phil Sturgeon, product manager, Stoplight, and Chairperson, Protect Earth.

Scrivener 3.1 1.0