Releases: OpenAPITools/openapi-diff
Releases Β· OpenAPITools/openapi-diff
2.1.0-beta.1
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
- @gloeglm made their first contribution in #302
- @seguri-doodle made their first contribution in #324
- @kaschula made their first contribution in #336
- @slinstaedt made their first contribution in #328
- @orange-buffalo made their first contribution in #327
- @julienrf made their first contribution in #318
- @hboutemy made their first contribution in #314
- @timur27 made their first contribution in #306
- @mikkela made their first contribution in #331
- @dedece35 made their first contribution in #359
- @eacolina made their first contribution in #388
Full Changelog: 2.0.1...2.1.0-beta.1
2.0.1
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
- swagger-snapshot: initial commits by @jmini in #35
- Return only diff state in cli by @quen2404 in #38
- Update swagger-parser by @quen2404 in #39
- feature: adds docker support by @itsjavi in #40
- docs: use full Docker hub image name by @itsjavi in #41
oneOf
full support by @quen2404 in #43- Handle
readOnly
&writeOnly
by @quen2404 in #42 - Vendor extensions support by @quen2404 in #44
- Fix
NullPointerException
withoneOf
discriminator change by @jmini in #49 - Improve extension support by @quen2404 in #50
- Extension: find changes when nothing changed by @quen2404 in #52
- Add support for changes in summary / description by @quen2404 in #61
- Fix NPE when only description changed in request content by @quen2404 in #65
- Fix/issue #66 wrong return in ref pointer by @quen2404 in #67
- Report causes for compatibility breakage by @thiagoarrais in #105
- improve
allOf
merging for composite schemas by @damianw in #85 - add
--fail-on-incompatible
option by @mohamed-el-habib in #74 - Bring in changes from joschi/openapi-diff by @joschi in #159
- Fix NPE when description is empty #154 by @jlamaille in #155
- Fix Issue #136 new read-only property breaks PUT by @trohrberg in #137
- WIP: Add swagger2 compatibility by @quen2404 in #54
- enable Dependabot v2 by @sullis in #161
- Add a "Join Slack" badge by @jmini in #167
- Add code of conduct, contributing.md by @wing328 in #168
- Build openapi-diff with Java 15 by @joschi in #173
- Update Maven and Docker image coordinates by @joschi in #172
- [build] Master/PR/Release workflows by @jimschubert in #181
- Add
--rm
and latest tag to container example by @jimschubert in #183 - Remove Lombok by @quen2404 in #175
- Migrate Java packages to
org.openapitools.openapidiff
by @joschi in #187 - Add sonar coverage reporting to master build by @jimschubert in #184
- Fix some code issues to pass Sonar quality gate by @joschi in #188
- Add diff results of operation ID (metadata) by @hiddewie in #191
- Add tests for content-type changes in request/response by @hiddewie in #190
- Fix nullable API response in diff by @gsdatta in #206
- Handle missing security schemes component by @jrouly in #211
- Allow paths resolving to same template but with different methods by @Trundle in #224
- Fix NPE with unnamed schemas in
{one,any,all}-of
by @gsdatta in #220 - Fix
--header
parameter by @derjust in #236 - Fix
NullPointerException
when diffing security schemes withoutcomponents
element by @hiddewie in #260 - Add JsonRender and --json command line option by @kimsey0 in #255
- Make large, recursive schemas diff-able by deferring computation of diffs by @solarhess in #249
- Support boolean values for
additionalProperties
by @joschi in #266 - Build with Java 17 by @joschi in #267
- feat: add a maven plugin by @misterjoshua in #278
- Add GitHub workflow for building Docker image by @joschi in #280
- Integrate building Docker image in release workflow by @joschi in #286
- Change packaging to maven-plugin by @kubamarchwicki in #287
- Ignore Maven dependencies in Dependabot by @joschi in #290
Dependency updates
- Set swagger-parser version to 2.0.1 by @jmini in #47
- Update Swagger-Parser to 2.0.4 by @jmini in #56
- build(deps): bump swagger-parser-v3 from 2.0.13 to 2.0.17 by @dependabot in #115
- build(deps): bump swagger-parser-v3 from 2.0.5 to 2.0.13 by @dependabot in #86
- build(deps): bump swagger-parser.version from 2.0.21 to 2.0.22 by @dependabot in #177
- build(deps): bump swagger-parser.version from 2.0.22 to 2.0.23 by @dependabot in #194
- build(deps): bump swagger-parser.version from 2.0.24 to 2.0.25 by @dependabot in #222
- build(deps): bump swagger-parser.version from 2.0.25 to 2.0.26 by @dependabot in #238
- build(deps): bump swagger-parser.version from 2.0.26 to 2.0.27 by @dependabot in #247
- build(deps): bump swagger-parser.version from 2.0.27 to 2.0.28 by @dependabot in #265
- build(deps): bump commons-cli from 1.4 to 1.5.0 by @dependabot in #274
- build(deps): bump commons-collections4 from 4.0 to 4.4 by @dependabot in #87
- build(deps): bump commons-lang3 from 3.11 to 3.12.0 by @dependabot in #217
- build(deps): bump j2html from 1.2.0 to 1.4.0 by @dependabot in https://github.com/OpenAPITools/...