2.0.0

[joschi]

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.

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

• swagger-snapshot: initial commits by @jmini in swagger-snapshot: initial commits #35
• Return only diff state in cli by @quen2404 in Return only diff state in cli #38
• Update swagger-parser by @quen2404 in Update swagger-parser #39
• feature: adds docker support by @itsjavi in feature: adds docker support #40
• docs: use full Docker hub image name by @itsjavi in docs: use full Docker hub image name #41
• oneOf full support by @quen2404 in Oneof full support #43
• Handle readOnly & writeOnly by @quen2404 in Handle readOnly & writeOnly #42
• Vendor extensions support by @quen2404 in Vendor extensions support #44
• Fix NullPointerException with oneOf discriminator change by @jmini in Fix NullPointerException with oneOf discriminator change #49
• Improve extension support by @quen2404 in Improve extension support #50
• Extension: find changes when nothing changed by @quen2404 in Extension: find changes when nothing changed #52
• Add support for changes in summary / description by @quen2404 in Add support for changes in summary / description #61
• Fix NPE when only description changed in request content by @quen2404 in Fix NPE when only description changed in request content #65
• Fix/issue Wrong handling for components/headers in RefPointer #66 wrong return in ref pointer by @quen2404 in Fix/issue 66 wrong return in ref pointer #67
• Report causes for compatibility breakage by @thiagoarrais in Report causes for compatibility breakage #105
• improve allOf merging for composite schemas by @damianw in improve allOf merging for composite schemas #85
• add --fail-on-incompatible option by @mohamed-el-habib in add fail-on-incompatible option #74
• Bring in changes from joschi/openapi-diff by @joschi in Bring in changes from joschi/openapi-diff #159
• Fix NPE when description is empty NPE with description empty in contract #154 by @jlamaille in Fix NPE when description is empty #154 #155
• Fix Issue Invalid backward compatibility result for new read-only property in PUT operations #136 new read-only property breaks PUT by @trohrberg in Fix Issue #136 new read-only property breaks PUT #137
• WIP: Add swagger2 compatibility by @quen2404 in WIP: Add swagger2 compatibility #54
• enable Dependabot v2 by @sullis in enable Dependabot v2 #161
• Add a "Join Slack" badge by @jmini in Add a "Join Slack" badge #167
• Add code of conduct, contributing.md by @wing328 in Add code of conduct, contributing.md #168
• Build openapi-diff with Java 15 by @joschi in Build openapi-diff with Java 15 #173
• Update Maven and Docker image coordinates by @joschi in Update Maven and Docker image coordinates #172
• [build] Master/PR/Release workflows by @jimschubert in [build] Master/PR/Release workflows #181
• Add --rm and latest tag to container example by @jimschubert in Add --rm and latest tag to container example #183
• Remove Lombok by @quen2404 in Remove lombok #175
• Migrate Java packages to org.openapitools.openapidiff by @joschi in Migrate Java packages to org.openapitools.openapidiff #187
• Add sonar coverage reporting to master build by @jimschubert in Add sonar coverage reporting to master build #184
• Fix some code issues to pass Sonar quality gate by @joschi in Fix some code issues to pass Sonar quality gate #188
• Add diff results of operation ID (metadata) by @hiddewie in Add diff results of operation ID (metadata) #191
• Add tests for content-type changes in request/response by @hiddewie in Add tests for content-type changes in request/response #190
• Fix nullable API response in diff by @gsdatta in Fix nullable API response in diff #206
• Handle missing security schemes component by @jrouly in Handle missing security schemes component #211
• Allow paths resolving to same template but with different methods by @Trundle in Allow paths resolving to same template but with different methods #224
• Fix NPE with unnamed schemas in {one,any,all}-of by @gsdatta in Fix NPE with unnamed schemas in {one,any,all}-of #220
• Fix --header parameter by @derjust in Fix --header parameter #236
• Fix NullPointerException when diffing security schemes without components element by @hiddewie in Fix NullPointerException when diffing security schemes without components element #260
• Add JsonRender and --json command line option by @kimsey0 in Add JsonRender and --json command line option #255
• Make large, recursive schemas diff-able by deferring computation of diffs by @solarhess in Make large, recursive schemas diff-able by deferring computation of diffs  #249
• Support boolean values for additionalProperties by @joschi in Support boolean values for additionalProperties #266
• Build with Java 17 by @joschi in Build with Java 17 #267
• feat: add a maven plugin by @misterjoshua in feat: add a maven plugin #278
• Add GitHub workflow for building Docker image by @joschi in Add GitHub workflow for building Docker image #280
• Integrate building Docker image in release workflow by @joschi in Integrate building Docker image in release workflow #286
• Change packaging to maven-plugin by @kubamarchwicki in Change packaging to maven-plugin #287
• Ignore Maven dependencies in Dependabot by @joschi in Ignore Maven dependencies in Dependabot #290

Dependency updates

• Set swagger-parser version to 2.0.1 by @jmini in Set swagger-parser version to 2.0.1 #47
• Update Swagger-Parser to 2.0.4 by @jmini in Update Swagger-Parser to 2.0.4 #56
• build(deps): bump swagger-parser-v3 from 2.0.13 to 2.0.17 by @dependabot in build(deps): bump swagger-parser-v3 from 2.0.13 to 2.0.17 #115
• build(deps): bump swagger-parser-v3 from 2.0.5 to 2.0.13 by @dependabot in build(deps): bump swagger-parser-v3 from 2.0.5 to 2.0.13 #86
• build(deps): bump swagger-parser.version from 2.0.21 to 2.0.22 by @dependabot in build(deps): bump swagger-parser.version from 2.0.21 to 2.0.22 #177
• build(deps): bump swagger-parser.version from 2.0.22 to 2.0.23 by @dependabot in build(deps): bump swagger-parser.version from 2.0.22 to 2.0.23 #194
• build(deps): bump swagger-parser.version from 2.0.24 to 2.0.25 by @dependabot in build(deps): bump swagger-parser.version from 2.0.24 to 2.0.25 #222
• build(deps): bump swagger-parser.version from 2.0.25 to 2.0.26 by @dependabot in build(deps): bump swagger-parser.version from 2.0.25 to 2.0.26 #238
• build(deps): bump swagger-parser.version from 2.0.26 to 2.0.27 by @dependabot in build(deps): bump swagger-parser.version from 2.0.26 to 2.0.27 #247
• build(deps): bump swagger-parser.version from 2.0.27 to 2.0.28 by @dependabot in build(deps): bump swagger-parser.version from 2.0.27 to 2.0.28 #265
• build(deps): bump commons-cli from 1.4 to 1.5.0 by @dependabot in build(deps): bump commons-cli from 1.4 to 1.5.0 #274
• build(deps): bump commons-collections4 from 4.0 to 4.4 by @dependabot in build(deps): bump commons-collections4 from 4.0 to 4.4 #87
• build(deps): bump commons-lang3 from 3.11 to 3.12.0 by @dependabot in build(deps): bump commons-lang3 from 3.11 to 3.12.0 #217
• build(deps): bump j2html from 1.2.0 to 1.4.0 by @dependabot in build(deps): bump j2html from 1.2.0 to 1.4.0 #99
• build(deps): bump j2html from 1.4.0 to 1.5.0 by @dependabot in build(deps): bump j2html from 1.4.0 to 1.5.0 #241
• build(deps): bump lombok from 1.18.10 to 1.18.12 by @dependabot in build(deps): bump lombok from 1.18.10 to 1.18.12 #131
• build(deps): bump lombok from 1.18.12 to 1.18.14 by @dependabot in build(deps): bump lombok from 1.18.12 to 1.18.14 #179
• build(deps): bump lombok from 1.18.2 to 1.18.8 by @dependabot in build(deps): bump lombok from 1.18.2 to 1.18.8 #78
• build(deps): bump lombok from 1.18.8 to 1.18.10 by @dependabot in build(deps): bump lombok from 1.18.8 to 1.18.10 #103
• build(deps): bump slf4j-api from 1.7.25 to 1.7.28 by @dependabot in build(deps): bump slf4j-api from 1.7.25 to 1.7.28 #92
• build(deps): bump slf4j-api from 1.7.28 to 1.7.30 by @dependabot in build(deps): bump slf4j-api from 1.7.28 to 1.7.30 #113
• build(deps): bump slf4j-log4j12 from 1.7.25 to 1.7.30 by @dependabot in build(deps): bump slf4j-log4j12 from 1.7.25 to 1.7.30 #112
• build(deps): bump slf4j.version from 1.7.30 to 1.7.31 by @dependabot in build(deps): bump slf4j.version from 1.7.30 to 1.7.31 #245
• build(deps): bump slf4j.version from 1.7.31 to 1.7.32 by @dependabot in build(deps): bump slf4j.version from 1.7.31 to 1.7.32 #250
• build(deps): bump actions/cache from 2.1.5 to 2.1.6 by @dependabot in build(deps): bump actions/cache from 2.1.5 to 2.1.6 #237
• build(deps): bump actions/cache from 2.1.6 to 2.1.7 by @dependabot in build(deps): bump actions/cache from 2.1.6 to 2.1.7 #291
• build(deps): bump actions/cache from v1 to v2.1.1 by @dependabot in build(deps): bump actions/cache from v1 to v2.1.1 #162
• build(deps): bump actions/cache from v2.1.1 to v2.1.2 by @dependabot in build(deps): bump actions/cache from v2.1.1 to v2.1.2 #180
• build(deps): bump actions/cache from v2.1.2 to v2.1.3 by @dependabot in build(deps): bump actions/cache from v2.1.2 to v2.1.3 #196
• build(deps): bump actions/cache from v2.1.3 to v2.1.4 by @dependabot in build(deps): bump actions/cache from v2.1.3 to v2.1.4 #214
• build(deps): bump actions/cache from v2.1.4 to v2.1.5 by @dependabot in build(deps): bump actions/cache from v2.1.4 to v2.1.5 #223
• build(deps): bump actions/checkout from 2 to 2.3.4 by @dependabot in build(deps): bump actions/checkout from 2 to 2.3.4 #231
• build(deps): bump actions/checkout from 2.3.4 to 2.3.5 by @dependabot in build(deps): bump actions/checkout from 2.3.4 to 2.3.5 #273
• build(deps): bump actions/checkout from 2.3.5 to 2.4.0 by @dependabot in build(deps): bump actions/checkout from 2.3.5 to 2.4.0 #275
• build(deps): bump actions/setup-java from v1 to v2 by @dependabot in build(deps): bump actions/setup-java from v1 to v2 #221
• build(deps): bump assertj-core from 3.10.0 to 3.13.2 by @dependabot in build(deps-dev): bump assertj-core from 3.10.0 to 3.13.2 #90
• build(deps): bump assertj-core from 3.13.2 to 3.14.0 by @dependabot in build(deps-dev): bump assertj-core from 3.13.2 to 3.14.0 #107
• build(deps): bump assertj-core from 3.14.0 to 3.17.0 by @dependabot in build(deps-dev): bump assertj-core from 3.14.0 to 3.17.0 #160
• build(deps): bump assertj-core from 3.17.0 to 3.17.1 by @dependabot in build(deps): bump assertj-core from 3.17.0 to 3.17.1 #166
• build(deps): bump assertj-core from 3.17.1 to 3.17.2 by @dependabot in build(deps): bump assertj-core from 3.17.1 to 3.17.2 #169
• build(deps): bump assertj-core from 3.17.2 to 3.18.0 by @dependabot in build(deps): bump assertj-core from 3.17.2 to 3.18.0 #193
• build(deps): bump assertj-core from 3.18.0 to 3.18.1 by @dependabot in build(deps): bump assertj-core from 3.18.0 to 3.18.1 #197
• build(deps): bump assertj-core from 3.18.1 to 3.19.0 by @dependabot in build(deps): bump assertj-core from 3.18.1 to 3.19.0 #210
• build(deps): bump assertj-core from 3.19.0 to 3.20.0 by @dependabot in build(deps): bump assertj-core from 3.19.0 to 3.20.0 #243
• build(deps): bump assertj-core from 3.20.0 to 3.20.1 by @dependabot in build(deps): bump assertj-core from 3.20.0 to 3.20.1 #244
• build(deps): bump assertj-core from 3.20.1 to 3.20.2 by @dependabot in build(deps): bump assertj-core from 3.20.1 to 3.20.2 #246
• build(deps): bump assertj-core from 3.20.2 to 3.21.0 by @dependabot in build(deps): bump assertj-core from 3.20.2 to 3.21.0 #262
• build(deps): bump fmt-maven-plugin from 2.6.0 to 2.9 by @dependabot in build(deps): bump fmt-maven-plugin from 2.6.0 to 2.9 #83
• build(deps): bump githook-maven-plugin from 1.0.0 to 1.0.4 by @dependabot in build(deps): bump githook-maven-plugin from 1.0.0 to 1.0.4 #97
• build(deps): bump githook-maven-plugin from 1.0.4 to 1.0.5 by @dependabot in build(deps): bump githook-maven-plugin from 1.0.4 to 1.0.5 #135
• build(deps): bump jacoco-maven-plugin from 0.8.6 to 0.8.7 by @dependabot in build(deps): bump jacoco-maven-plugin from 0.8.6 to 0.8.7 #228
• build(deps): bump joschi/setup-jdk from v1 to v2.2.0 by @dependabot in build(deps): bump joschi/setup-jdk from v1 to v2.2.0 #163
• build(deps): bump joschi/setup-jdk from v2.2.0 to v2.3.0 by @dependabot in build(deps): bump joschi/setup-jdk from v2.2.0 to v2.3.0 #178
• build(deps): bump junit-bom from 5.6.2 to 5.7.0 by @dependabot in build(deps): bump junit-bom from 5.6.2 to 5.7.0 #171
• build(deps): bump junit-bom from 5.7.0 to 5.7.1 by @dependabot in build(deps): bump junit-bom from 5.7.0 to 5.7.1 #213
• build(deps): bump junit-bom from 5.7.1 to 5.7.2 by @dependabot in build(deps): bump junit-bom from 5.7.1 to 5.7.2 #233
• build(deps): bump junit-bom from 5.7.2 to 5.8.0 by @dependabot in build(deps): bump junit-bom from 5.7.2 to 5.8.0 #259
• build(deps): bump junit-bom from 5.8.0 to 5.8.1 by @dependabot in build(deps): bump junit-bom from 5.8.0 to 5.8.1 #263
• build(deps): bump junit-bom from 5.8.1 to 5.8.2 by @dependabot in build(deps): bump junit-bom from 5.8.1 to 5.8.2 #294
• build(deps): bump junit.jupiter.version from 5.1.0 to 5.4.2 by @dependabot in build(deps-dev): bump junit.jupiter.version from 5.1.0 to 5.4.2 #75
• build(deps): bump junit.jupiter.version from 5.4.2 to 5.5.2 by @dependabot in build(deps-dev): bump junit.jupiter.version from 5.4.2 to 5.5.2 #102
• build(deps): bump junit.jupiter.version from 5.5.2 to 5.6.2 by @dependabot in build(deps-dev): bump junit.jupiter.version from 5.5.2 to 5.6.2 #141
• build(deps): bump junit.platform.version from 1.1.0 to 1.3.2 by @dependabot in build(deps): bump junit.platform.version from 1.1.0 to 1.3.2 #100
• build(deps): bump maven-compiler-plugin from 3.2 to 3.8.1 by @dependabot in build(deps): bump maven-compiler-plugin from 3.2 to 3.8.1 #80
• build(deps): bump maven-gpg-plugin from 1.6 to 3.0.1 by @dependabot in build(deps): bump maven-gpg-plugin from 1.6 to 3.0.1 #229
• build(deps): bump maven-javadoc-plugin from 3.0.0 to 3.1.1 by @dependabot in build(deps): bump maven-javadoc-plugin from 3.0.0 to 3.1.1 #98
• build(deps): bump maven-javadoc-plugin from 3.1.1 to 3.2.0 by @dependabot in build(deps): bump maven-javadoc-plugin from 3.1.1 to 3.2.0 #133
• build(deps): bump maven-javadoc-plugin from 3.2.0 to 3.3.0 by @dependabot in build(deps): bump maven-javadoc-plugin from 3.2.0 to 3.3.0 #235
• build(deps): bump maven-javadoc-plugin from 3.3.0 to 3.3.1 by @dependabot in build(deps): bump maven-javadoc-plugin from 3.3.0 to 3.3.1 #258
• build(deps): bump maven-plugin-plugin from 3.6.0 to 3.6.1 by @dependabot in build(deps): bump maven-plugin-plugin from 3.6.0 to 3.6.1 #283
• build(deps): bump maven-plugin-plugin from 3.6.1 to 3.6.2 by @dependabot in build(deps): bump maven-plugin-plugin from 3.6.1 to 3.6.2 #295
• build(deps): bump maven-site-plugin from 3.8.2 to 3.9.1 by @dependabot in build(deps): bump maven-site-plugin from 3.8.2 to 3.9.1 #285
• build(deps): bump maven-source-plugin from 3.0.1 to 3.1.0 by @dependabot in build(deps): bump maven-source-plugin from 3.0.1 to 3.1.0 #81
• build(deps): bump maven-source-plugin from 3.1.0 to 3.2.1 by @dependabot in build(deps): bump maven-source-plugin from 3.1.0 to 3.2.1 #116
• build(deps): bump maven-surefire-plugin from 2.19.1 to 2.22.2 by @dependabot in build(deps): bump maven-surefire-plugin from 2.19.1 to 2.22.2 #84
• build(deps): bump rokroskar/workflow-run-cleanup-action from v0.2.2 to v0.3.0 by @dependabot in build(deps): bump rokroskar/workflow-run-cleanup-action from v0.2.2 to v0.3.0 #205
• build(deps): bump rokroskar/workflow-run-cleanup-action from v0.3.0 to v0.3.1 by @dependabot in build(deps): bump rokroskar/workflow-run-cleanup-action from v0.3.0 to v0.3.1 #218
• build(deps): bump rokroskar/workflow-run-cleanup-action from v0.3.1 to v0.3.2 by @dependabot in build(deps): bump rokroskar/workflow-run-cleanup-action from v0.3.1 to v0.3.2 #219
• build(deps): bump rokroskar/workflow-run-cleanup-action from v0.3.2 to v0.3.3 by @dependabot in build(deps): bump rokroskar/workflow-run-cleanup-action from v0.3.2 to v0.3.3 #225
• build(deps): bump sonar-maven-plugin from 3.7.0.1746 to 3.8.0.2131 by @dependabot in build(deps): bump sonar-maven-plugin from 3.7.0.1746 to 3.8.0.2131 #209
• build(deps): bump sonar-maven-plugin from 3.8.0.2131 to 3.9.0.2155 by @dependabot in build(deps): bump sonar-maven-plugin from 3.8.0.2131 to 3.9.0.2155 #227
• build(deps): bump sonar-maven-plugin from 3.9.0.2155 to 3.9.1.2184 by @dependabot in build(deps): bump sonar-maven-plugin from 3.9.0.2155 to 3.9.1.2184 #277
• Bump Maven to version 3.8.4

New Contributors

• @itsjavi made their first contribution in feature: adds docker support #40
• @thiagoarrais made their first contribution in Report causes for compatibility breakage #105
• @damianw made their first contribution in improve allOf merging for composite schemas #85
• @mohamed-el-habib made their first contribution in add fail-on-incompatible option #74
• @jlamaille made their first contribution in Fix NPE when description is empty #154 #155
• @trohrberg made their first contribution in Fix Issue #136 new read-only property breaks PUT #137
• @sullis made their first contribution in enable Dependabot v2 #161
• @wing328 made their first contribution in Add code of conduct, contributing.md #168
• @jimschubert made their first contribution in [build] Master/PR/Release workflows #181
• @hiddewie made their first contribution in Add diff results of operation ID (metadata) #191
• @gsdatta made their first contribution in Fix nullable API response in diff #206
• @jrouly made their first contribution in Handle missing security schemes component #211
• @Trundle made their first contribution in Allow paths resolving to same template but with different methods #224
• @derjust made their first contribution in Fix --header parameter #236
• @kimsey0 made their first contribution in Add JsonRender and --json command line option #255
• @solarhess made their first contribution in Make large, recursive schemas diff-able by deferring computation of diffs  #249
• @misterjoshua made their first contribution in feat: add a maven plugin #278
• @kubamarchwicki made their first contribution in Change packaging to maven-plugin #287

---

This discussion was created from the release 2.0.0.