Gradle plugin for oasdiff: a tool to compare and detect breaking changes in OpenAPI specs.

First, add the plugin to the plugin block of the build script

plugins {
    id("io.github.stefankoppier.oasdiff") version "x.y.z"
}

This will add two Gradle tasks: oasdiffInstall and oasdiffCheckBreaking in the group oasdiff. oasdiffInstall is not required to be executed manually as oasdiffCheckBreaking depends on oasdiffInstall.

To run oasdiffCheckBreaking the following minimal configuration must be applied

oasdiff {
    base.set("base-specification.yml")
    revision.set("revision-specification.yml")
}

which sets the base specification and the revision to compare the breaking changes.

The following addition configuration options are available

This project is a wrapper around oasdiff by Tufin.