Skip to content

Releases: OpenAPITools/openapi-diff

2.1.0-beta.1

26 Jun 21:07
Compare
Choose a tag to compare
2.1.0-beta.1 Pre-release
Pre-release

What's Changed

  • Migrate from Log4j 1.2.x to Logback by @joschi in #307
  • Exclude null properties when rendering JSON by @gloeglm in #302
  • Remove dependency on commons-httpclient by @joschi in #308
  • Use SLF4J commons-logging bridge by @joschi in #311
  • build(deps): bump maven-site-plugin from 3.9.1 to 3.10.0 by @dependabot in #313
  • build(deps): bump assertj-core from 3.21.0 to 3.22.0 by @dependabot in #315
  • Update README.md by @seguri-doodle in #324
  • build(deps): bump maven-compiler-plugin from 3.8.1 to 3.10.0 by @dependabot in #333
  • build(deps): bump slf4j.version from 1.7.32 to 1.7.33 by @dependabot in #323
  • build(deps): bump maven-jar-plugin from 3.2.0 to 3.2.2 by @dependabot in #322
  • build(deps): bump maven-plugin-plugin from 3.6.2 to 3.6.4 by @dependabot in #340
  • build(deps): bump nexus-staging-maven-plugin from 1.6.8 to 1.6.12 by @dependabot in #339
  • build(deps): bump maven-javadoc-plugin from 3.3.1 to 3.3.2 by @dependabot in #341
  • build(deps): bump maven-site-plugin from 3.10.0 to 3.11.0 by @dependabot in #342
  • build(deps): bump slf4j.version from 1.7.33 to 1.7.36 by @dependabot in #338
  • Update Docker release action with multi-platform by @kaschula in #336
  • build(deps): bump swagger-parser.version from 2.0.28 to 2.0.30 by @dependabot in #337
  • fix: mixed up logic around response mediatype addition/removal by @slinstaedt in #328
  • #198: Fixing false positive breaking change reported when removing an optional field from a response by @orange-buffalo in #327
  • Support allOf schemas referring to oneOf schemas by @julienrf in #318
  • build(deps): bump actions/checkout from 2.4.0 to 3 by @dependabot in #343
  • upgrade m-release-p: outputTimestamp auto-update by @hboutemy in #314
  • Equivalent paths with overloaded parameters are supported by @timur27 in #306
  • Fix stackoverflow in recursive definitions by @mikkela in #331
  • build(deps): bump logback-classic from 1.2.10 to 1.2.11 by @dependabot in #347
  • build(deps): bump maven-compiler-plugin from 3.10.0 to 3.10.1 by @dependabot in #350
  • build(deps): bump swagger-parser.version from 2.0.30 to 2.0.31 by @dependabot in #354
  • build(deps): bump actions/cache from 2.1.7 to 3 by @dependabot in #356
  • build(deps): bump maven-shade-plugin from 3.2.4 to 3.3.0 by @dependabot in #360
  • build(deps): bump swagger-parser.version from 2.0.31 to 2.0.32 by @dependabot in #363
  • build(deps): bump jacoco-maven-plugin from 0.8.7 to 0.8.8 by @dependabot in #365
  • build(deps): bump actions/setup-java from 2 to 3 by @dependabot in #367
  • build(deps): bump maven-site-plugin from 3.11.0 to 3.12.0 by @dependabot in #368
  • build(deps): bump maven-javadoc-plugin from 3.3.2 to 3.4.0 by @dependabot in #369
  • build(deps): bump nexus-staging-maven-plugin from 1.6.12 to 1.6.13 by @dependabot in #370
  • build(deps): bump docker/login-action from 1 to 2 by @dependabot in #374
  • build(deps): bump docker/setup-buildx-action from 1 to 2 by @dependabot in #373
  • build(deps): bump docker/build-push-action from 2 to 3 by @dependabot in #372
  • build(deps): bump swagger-parser.version from 2.0.32 to 2.0.33 by @dependabot in #376
  • build(deps): bump assertj-core from 3.22.0 to 3.23.0 by @dependabot in #377
  • build(deps): bump assertj-core from 3.23.0 to 3.23.1 by @dependabot in #378
  • Add support for remote development with Gitpod by @joschi in #379
  • Generate SBOM using CycloneDX Maven plugin by @joschi in #382
  • Bump Maven to version 3.8.5 and Maven wrapper to version 3.1.1 by @joschi in #383
  • fix #358 - correction of regex problem + tests + auto formatting by @dedece35 in #359
  • build(deps): bump maven-release-plugin from 3.0.0-M5 to 3.0.0-M6 by @dependabot in #385
  • build(deps): bump swagger-parser.version from 2.0.33 to 2.1.0 by @dependabot in #386
  • build(deps): bump swagger-parser.version from 2.1.0 to 2.1.1 by @dependabot in #387
  • Fix: Crashes when parsing diff for very large specs by @eacolina in #388

New Contributors

Full Changelog: 2.0.1...2.1.0-beta.1

2.0.1

27 Dec 01:33
Compare
Choose a tag to compare

What's Changed

  • Enable reproducible builds by @joschi in #300
  • Skip Git hook repository check to enable build without .git by @joschi in #301

Full Changelog: 2.0.0...2.0.1

2.0.0

05 Dec 15:26
Compare
Choose a tag to compare

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