Skip to content

v0.1.14

Choose a tag to compare

View all tags
@reuvenharrison reuvenharrison released this 30 Aug 22:25
· 7 commits to main since this release
v0.1.14
54d7a75
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Highlights

Upgraded to oasdiff v1.30.0

Every action now runs on oasdiff v1.30.0, the largest change to breaking-change detection since the checker was introduced. Severities are now derived from a single reviewed model of what each change does to the API contract, which corrected 36 checks and added 58 new ones, so the breaking and changelog actions may report differently on the same diff:

  • Changes that now fail a breaking step: setting a bound (maxLength, minItems, multipleOf and friends) where none existed, removing a security requirement or adding a security scope, adding a branch or value to a response union.
  • Changes that no longer fail: request parameter default changes, removing optional response properties and headers, dropping an allOf conjunct.
  • New detection: OpenAPI 3.1 boolean schemas (items: false tuples), positional prefixItems comparison (reordering entries is now caught), OpenAPI 3.2 QUERY and custom methods, and constraint keywords that were previously unchecked (maxItems, maxProperties, minProperties, multipleOf, uniqueItems).

If a step starts failing on a change your team accepts, override that check's severity with severity-levels in .oasdiff.yaml in your repo; the full list of changed checks is in the oasdiff v1.30.0 release notes.

Full Changelog: v0.1.13...v0.1.14

Assets 2
Loading