Skip to content

Releases: OpenAPITools/openapi-diff

2.1.0-beta.8

16 Dec 22:53

Choose a tag to compare

2.1.0-beta.8 Pre-release
Pre-release

What's Changed

  • build(deps): bump org.apache.commons:commons-lang3 from 3.12.0 to 3.13.0 by @dependabot in #554
  • build(deps): bump ch.qos.logback:logback-classic from 1.3.8 to 1.3.9 by @dependabot in #556
  • build(deps): bump ch.qos.logback:logback-classic from 1.3.9 to 1.3.11 by @dependabot in #557
  • build(deps): bump slf4j.version from 2.0.7 to 2.0.9 by @dependabot in #560
  • build(deps): bump actions/checkout from 3 to 4 by @dependabot in #561
  • build(deps): bump docker/login-action from 2 to 3 by @dependabot in #563
  • build(deps): bump docker/setup-buildx-action from 2 to 3 by @dependabot in #564
  • build(deps): bump docker/build-push-action from 4 to 5 by @dependabot in #565
  • build(deps): bump docker/setup-qemu-action from 2 to 3 by @dependabot in #566
  • build(deps): bump org.sonarsource.scanner.maven:sonar-maven-plugin from 3.9.1.2184 to 3.10.0.2594 by @dependabot in #567
  • build(deps): bump org.apache.maven.plugins:maven-javadoc-plugin from 3.5.0 to 3.6.0 by @dependabot in #568
  • Build with Java 21 by @joschi in #570
  • build(deps): bump org.apache.maven.plugins:maven-shade-plugin from 3.5.0 to 3.5.1 by @dependabot in #572
  • build(deps): bump org.jacoco:jacoco-maven-plugin from 0.8.10 to 0.8.11 by @dependabot in #574
  • build(deps): bump swagger-parser.version from 2.1.16 to 2.1.18 by @dependabot in #575
  • build(deps): bump org.apache.maven.plugins:maven-surefire-plugin from 3.1.2 to 3.2.1 by @dependabot in #577
  • build(deps): bump commons-cli:commons-cli from 1.5.0 to 1.6.0 by @dependabot in #578
  • build(deps): bump org.cyclonedx:cyclonedx-maven-plugin from 2.7.9 to 2.7.10 by @dependabot in #579
  • build(deps): bump org.junit:junit-bom from 5.10.0 to 5.10.1 by @dependabot in #581
  • build(deps): bump org.apache.maven.plugins:maven-javadoc-plugin from 3.6.0 to 3.6.2 by @dependabot in #584
  • build(deps): bump org.apache.maven.plugins:maven-surefire-plugin from 3.2.1 to 3.2.2 by @dependabot in #582
  • build(deps): bump org.apache.commons:commons-lang3 from 3.13.0 to 3.14.0 by @dependabot in #587
  • build(deps): bump swagger-parser.version from 2.1.18 to 2.1.19 by @dependabot in #586
  • build(deps): bump ch.qos.logback:logback-classic from 1.3.11 to 1.3.12 by @dependabot in #588
  • build(deps): bump ch.qos.logback:logback-classic from 1.3.12 to 1.3.13 by @dependabot in #589
  • build(deps): bump actions/setup-java from 3 to 4 by @dependabot in #591
  • build(deps): bump ch.qos.logback:logback-classic from 1.3.13 to 1.3.14 by @dependabot in #593
  • build(deps): bump org.apache.maven.plugins:maven-javadoc-plugin from 3.6.2 to 3.6.3 by @dependabot in #592
  • build(deps): bump org.apache.maven.plugins:maven-surefire-plugin from 3.2.2 to 3.2.3 by @dependabot in #596
  • fix(594): fix console rendering by @TheFreaky in #595
  • Docs: Add JSON files to inital introduction sentence by @LitschiW in #580
  • Adding Asciidoc Render by @nbiastaunton in #569
  • add test case for fixed NPE in rename of parameter (#488) by @stoeren in #555
  • Configurable incompatibility checks by @westse in #552
  • Option to create html doc with all changes by @nithintatikonda1 in #541

New Contributors

Full Changelog: 2.1.0-beta.7...2.1.0-beta.8

2.1.0-beta.7

25 Jul 21:57

Choose a tag to compare

2.1.0-beta.7 Pre-release
Pre-release

What's Changed

  • build(deps): bump cyclonedx-maven-plugin from 2.7.5 to 2.7.6 by @dependabot in #505
  • build(deps): bump jacoco-maven-plugin from 0.8.8 to 0.8.9 by @dependabot in #504
  • build(deps): bump logback-classic from 1.3.0 to 1.3.7 by @dependabot in #509
  • build(deps): bump cyclonedx-maven-plugin from 2.7.6 to 2.7.7 by @dependabot in #507
  • build(deps): bump jacoco-maven-plugin from 0.8.9 to 0.8.10 by @dependabot in #513
  • build(deps): bump junit-bom from 5.9.2 to 5.9.3 by @dependabot in #514
  • build(deps): bump cyclonedx-maven-plugin from 2.7.7 to 2.7.8 by @dependabot in #515
  • build(deps): bump maven-gpg-plugin from 3.0.1 to 3.1.0 by @dependabot in #518
  • build(deps): bump maven-surefire-plugin from 3.0.0 to 3.1.0 by @dependabot in #519
  • build(deps): bump cyclonedx-maven-plugin from 2.7.8 to 2.7.9 by @dependabot in #524
  • build(deps): bump swagger-parser.version from 2.1.13 to 2.1.14 by @dependabot in #521
  • build(deps): bump maven-source-plugin from 3.2.1 to 3.3.0 by @dependabot in #526
  • build(deps): bump swagger-parser.version from 2.1.14 to 2.1.15 by @dependabot in #527
  • build(deps): bump maven-release-plugin from 3.0.0 to 3.0.1 by @dependabot in #529
  • build(deps): bump maven-surefire-plugin from 3.1.0 to 3.1.2 by @dependabot in #530
  • build(deps): bump logback-classic from 1.3.7 to 1.3.8 by @dependabot in #531
  • build(deps): bump maven-shade-plugin from 3.4.1 to 3.5.0 by @dependabot in #533
  • build(deps): bump swagger-parser.version from 2.1.15 to 2.1.16 by @dependabot in #536
  • Use Maven wrapper in pre-commit hook by @westse in #540
  • build(deps): bump org.junit:junit-bom from 5.9.3 to 5.10.0 by @dependabot in #548
  • Improve backward-compatibility testing by @westse in #546
  • bug fix: parameter compared with itself html by @nithintatikonda1 in #547
  • Fix renderer memory issues by writing to OutputStream by @LubomirS in #544
  • Fix potential NPEs in ParametersDiff and HtmlRender by @bmistry13 in #517
  • Treat new PUT request properties as compatible again by @westse in #538
  • Add file output parameters to Maven plugin by @studur in #502

New Contributors

Full Changelog: 2.1.0-beta.6...2.1.0-beta.7

2.1.0-beta.6

27 Mar 21:23

Choose a tag to compare

2.1.0-beta.6 Pre-release
Pre-release

What's Changed

  • build(deps): bump maven-surefire-plugin from 2.22.2 to 3.0.0 by @dependabot in #491
  • build(deps): bump slf4j.version from 2.0.6 to 2.0.7 by @dependabot in #494
  • build(deps): bump maven-release-plugin from 3.0.0-M7 to 3.0.0 by @dependabot in #493
  • build(deps): bump maven-deploy-plugin from 3.1.0 to 3.1.1 by @dependabot in #496
  • build(deps): bump swagger-parser.version from 2.1.12 to 2.1.13 by @dependabot in #499

Full Changelog: 2.1.0-beta.5...2.1.0-beta.6

2.1.0-beta.5

28 Feb 21:07

Choose a tag to compare

2.1.0-beta.5 Pre-release
Pre-release

What's Changed

  • build(deps): bump swagger-parser.version from 2.1.6 to 2.1.7 by @dependabot in #432
  • build(deps): bump maven-shade-plugin from 3.4.0 to 3.4.1 by @dependabot in #431
  • build(deps): bump maven-release-plugin from 3.0.0-M6 to 3.0.0-M7 by @dependabot in #434
  • build(deps): bump swagger-parser.version from 2.1.7 to 2.1.8 by @dependabot in #433
  • build(deps): bump maven-plugin-plugin from 3.6.4 to 3.7.0 by @dependabot in #435
  • build(deps): bump cyclonedx-maven-plugin from 2.7.2 to 2.7.3 by @dependabot in #436
  • build(deps): bump swagger-parser.version from 2.1.8 to 2.1.9 by @dependabot in #437
  • build(deps): bump slf4j.version from 2.0.3 to 2.0.4 by @dependabot in #438
  • build(deps): bump slf4j.version from 2.0.4 to 2.0.5 by @dependabot in #442
  • build(deps): bump slf4j.version from 2.0.5 to 2.0.6 by @dependabot in #444
  • build(deps): bump cyclonedx-maven-plugin from 2.7.3 to 2.7.4 by @dependabot in #446
  • build(deps): bump assertj-core from 3.23.1 to 3.24.0 by @dependabot in #447
  • build(deps): bump assertj-core from 3.24.0 to 3.24.1 by @dependabot in #451
  • build(deps): bump swagger-parser.version from 2.1.9 to 2.1.10 by @dependabot in #450
  • build(deps): bump junit-bom from 5.9.1 to 5.9.2 by @dependabot in #452
  • build(deps): bump maven-plugin-plugin from 3.7.0 to 3.7.1 by @dependabot in #455
  • build(deps): bump assertj-core from 3.24.1 to 3.24.2 by @dependabot in #456
  • build(deps): bump swagger-parser.version from 2.1.10 to 2.1.11 by @dependabot in #457
  • build(deps): bump docker/build-push-action from 3 to 4 by @dependabot in #459
  • build(deps): bump maven-deploy-plugin from 3.0.0 to 3.1.0 by @dependabot in #462
  • build(deps): bump swagger-parser.version from 2.1.11 to 2.1.12 by @dependabot in #467
  • build(deps): bump maven-javadoc-plugin from 3.4.1 to 3.5.0 by @dependabot in #466
  • build(deps): bump cyclonedx-maven-plugin from 2.7.4 to 2.7.5 by @dependabot in #465
  • Fix: Parameter change detection fix when path doesn't change but PathParams AND Parameters are changed (But named the same) by @mishukdutta-toast in #353 #348
  • Detect changed numeric ranges by @joschi in #469
  • Add Maven skip property to skip execution by @joschi in #471
  • bugfix (to master): after openapi specs comparison, all parameters are removed by @justinasbardauskas in #454
  • build(deps): bump maven-plugin-plugin from 3.7.1 to 3.8.1 by @dependabot in #473
  • build(deps): bump maven-compiler-plugin from 3.10.1 to 3.11.0 by @dependabot in #472

New Contributors

Full Changelog: 2.1.0-beta.4...2.1.0-beta.5

2.1.0-beta.4

24 Oct 20:38

Choose a tag to compare

2.1.0-beta.4 Pre-release
Pre-release

What's Changed

  • build(deps): bump junit-bom from 5.8.2 to 5.9.0 by @dependabot in #399
  • build(deps): bump maven-site-plugin from 3.12.0 to 3.12.1 by @dependabot in #400
  • build(deps): bump maven-javadoc-plugin from 3.4.0 to 3.4.1 by @dependabot in #401
  • build(deps): bump swagger-parser.version from 2.1.1 to 2.1.2 by @dependabot in #402
  • build(deps): bump slf4j.version from 1.7.36 to 2.0.0 by @dependabot in #403
  • build(deps): bump logback-classic from 1.2.11 to 1.3.0 by @dependabot in #404
  • build(deps): bump slf4j.version from 2.0.0 to 2.0.1 by @dependabot in #411
  • build(deps): bump maven-shade-plugin from 3.3.0 to 3.4.0 by @dependabot in #409
  • build(deps): bump maven-jar-plugin from 3.2.2 to 3.3.0 by @dependabot in #413
  • build(deps): bump slf4j.version from 2.0.1 to 2.0.2 by @dependabot in #417
  • build(deps): bump junit-bom from 5.9.0 to 5.9.1 by @dependabot in #416
  • build(deps): bump slf4j.version from 2.0.2 to 2.0.3 by @dependabot in #421
  • build(deps): bump swagger-parser.version from 2.1.2 to 2.1.3 by @dependabot in #420
  • build(deps): bump cyclonedx-maven-plugin from 2.7.1 to 2.7.2 by @dependabot in #426
  • build(deps): bump swagger-parser.version from 2.1.3 to 2.1.5 by @dependabot in #428
  • build(deps): bump swagger-parser.version from 2.1.5 to 2.1.6 by @dependabot in #429
  • Add 2 lf instead of 1 at the end of Markdown blockquotes by @bbenoist in #427
  • Register ObjectMapper modules by @jasper-vandemalle in #419

New Contributors

Full Changelog: 2.1.0-beta.3...2.1.0-beta.4

2.1.0-beta.3

25 Jul 11:50

Choose a tag to compare

2.1.0-beta.3 Pre-release
Pre-release

What's Changed

  • build(deps): bump cyclonedx-maven-plugin from 2.7.0 to 2.7.1 by @dependabot in #396
  • build(deps): bump maven-deploy-plugin from 2.8.2 to 3.0.0 by @dependabot in #395
  • Fix: Markdown and Console renderer fail when processing range HTTP status code e. g. '2XX' by @TimoBehrendt in #397

New Contributors

Full Changelog: 2.1.0-beta.2...2.1.0-beta.3

2.1.0-beta.2

07 Jul 19:41

Choose a tag to compare

2.1.0-beta.2 Pre-release
Pre-release

What's Changed

New Contributors

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

2.1.0-beta.1

26 Jun 21:07

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

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

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