Skip to content

Releases: OpenAPITools/openapi-diff

2.0.0

05 Dec 15:26
@joschi joschi
2.0.0
bdd83e2

Choose a tag to compare

View all tags
2.0.0

This is the first stable release of OpenAPI-Diff under the umbrella of the OpenAPI Tools organization.

Many thanks to all contributors, especially the OpenAPI Tools team (@jmini, @jimschubert, @wing328) for their support during on-boarding, and @misterjoshua for contributing the OpenAPI-Diff Maven plugin and joining the development team.

💬 Release discussion: #297
ℹ️ Milestone: https://github.com/OpenAPITools/openapi-diff/milestone/1?closed=1

Installation

Maven/Gradle

OpenAPI-Diff is available on Maven Central:

<dependency>
  <groupId>org.openapitools.openapidiff</groupId>
  <artifactId>openapi-diff-core</artifactId>
  <version>2.0.0</version>
</dependency>
dependencies {
    implementation("org.openapitools.openapidiff:openapi-diff-core:2.0.0")
}

Docker

OpenAPI-Diff is available on Docker Hub as openapitools/openapi-diff:

# docker run --rm openapitools/openapi-diff:2.0.0
usage: openapi-diff <old> <new>
[...]

Command Line

# curl -o openapi-diff.jar 'https://repo1.maven.org/maven2/org/openapitools/openapidiff/openapi-diff-cli/2.0.0/openapi-diff-cli-2.0.0-all.jar'
# java -jar openapi-diff.jar --help
usage: openapi-diff <old> <new>
[...]

Maven Plugin

OpenAPI-Diff is also available as Maven plugin to include into your build:

<plugin>
  <groupId>org.openapitools.openapidiff</groupId>
  <artifactId>openapi-diff-maven</artifactId>
  <version>2.0.0</version>
  <executions>
    <execution>
      <goals>
        <goal>diff</goal>
      </goals>
      <configuration>
        <!-- Reference specification (perhaps your prod schema) -->
        <oldSpec>https://petstore3.swagger.io/api/v3/openapi.json</oldSpec>
        <!-- Specification generated by your project in the compile phase -->
        <newSpec>${project.basedir}/target/openapi.yaml</newSpec>
        <!-- Fail only if API changes broke backward compatibility (default: false) -->
        <failOnIncompatible>true</failOnIncompatible>
        <!-- Fail if API changed (default: false) -->
        <failOnChanged>true</failOnIncompatible>
      </configuration>
    </execution>
  </executions>
</plugin>

What's Changed

Full Changelog: 1.2.0...2.0.0

New features and bug fixes

Dependency updates

Read more

Contributors

thiagoarrais, sullis, and 20 other contributors
Loading
0 Join discussion