install

Additional install commands

macOS

Homebrewverified · 100%

brew install openapi-diff

local Homebrew formula metadata

Linux

Arch Linux pacmanverified · 92%

sudo pacman -S openapi-diff

Arch Linux sync databases · openapi-diff · source: geo.mirror.pkgbuild.com

overview

Package summary

Utility for comparing two OpenAPI specifications

Project links

Commands and aliases

openapi-diff

history

Project history and usage

openapi-diff is an OpenAPITools utility for comparing two OpenAPI 3.x specifications and rendering the differences as text, HTML, Markdown, AsciiDoc, or JSON. Its main job is to tell teams whether an API description changed and whether those changes are compatible or incompatible.

Project history

The repository was created on December 12, 2017 and later moved under the OpenAPITools umbrella. A project discussion for version 2.0.0 on December 5, 2021 described that release as the first stable OpenAPI-Diff release under the OpenAPI Tools organization.

Adoption history

The project is distributed as Java artifacts on Maven Central, a Docker image under `openapitools/openapi-diff`, and a Homebrew formula. That packaging mix reflects its use both as a library/plugin in Java builds and as a standalone CLI in local or CI workflows.

How it is used

Developers invoke `openapi-diff <old> <new>` against local files or HTTP URLs, then choose renderers or state-only output. CI users can turn compatibility checks into gates with options such as `--fail-on-incompatible` or `--fail-on-changed`.

Java projects can add the Maven plugin to compare a reference specification against a generated build artifact during tests. The README also documents direct invocation through the core API for custom comparison tooling.

Why package nerds care

openapi-diff is package-nerd-interesting because it treats API descriptions as build artifacts with semantic compatibility. It turns OpenAPI files from passive documentation into something package managers, CI systems, and release processes can enforce.

Timeline

December 12, 2017: the GitHub repository was created. December 5, 2021: the 2.0.0 discussion announced the first stable OpenAPI-Diff release under OpenAPI Tools. January 26, 2026: GitHub releases list version 2.1.7.

Related projects

openapi-diff lives in the OpenAPITools ecosystem alongside OpenAPI Generator and shares the same broader OpenAPI/Swagger tooling context.

Sources

security posture

Risk level: green

narrow executable package without higher-risk signals.

Risk classifier

green risk · low confidence · appliance

Why

narrow executable package without higher-risk signals

Signals

metadata:no-higher-risk-signals

Install behavior

No Homebrew post-install hook is recorded in formula metadata.
Homebrew bottle metadata is available for 1 platform targets.
Installs with 1 runtime dependencies.
Build metadata lists 1 build dependencies.

Recommended review

Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.

executables

Installed executables

Command	Kind	Exposure	Note
`openapi-diff`	cli	global executable

freshness

Version and freshness

These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.

page generated2026-07-08

manager version2.1.7

manager updated2026-06-22

local dataok

upstreamcurrent

latest detected2.1.7

https://github.com/OpenAPITools/openapi-diff

okNo freshness warnings were generated.

install metadata

Package metadata

Package key	brew:openapi-diff
Version	2.1.7
Package manager	Homebrew
Package manager page	https://formulae.brew.sh/formula/openapi-diff
Homepage	https://github.com/OpenAPITools/openapi-diff
Repository	https://github.com/OpenAPITools/openapi-diff
Upstream docs	https://github.com/OpenAPITools/openapi-diff#readme
License	Apache-2.0
Source archive	https://github.com/OpenAPITools/openapi-diff/archive/refs/tags/2.1.7.tar.gz
Last updated	2026-06-22T14:05:41-07:00
Pulse	updated
Dependencies	openjdk
Build dependencies	maven
Bottle	available (on all)
Homebrew post-install	not defined
Service	none declared

registry facts

Source database details

Source Database	Homebrew formula API
Tap	homebrew/core
Full Name	openapi-diff
Version Scheme	0
Revision	0
Bottle Stable Root URL	https://ghcr.io/v2/homebrew/core
Deprecated	no
Disabled	no
Keg Only	no
URL Keys	stable

source database matches

Other package-manager records

Matches are pulled from external package-manager indexes and kept separate from local Automic Vault package links.

pacman95%

openapi-diff 2.1.7-1

Utility for comparing two OpenAPI specifications

https://github.com/OpenAPITools/openapi-diff

sudo pacman -S openapi-diff

License: 0BSD AND Apache-2.0
Architecture: any
2 dependencies
normalized package name match
Matched by: Openapi Diff

Arch Linux sync databases · geo.mirror.pkgbuild.com · Arch Linux sync databases: openapi-diff from https://geo.mirror.pkgbuild.com/extra/os/x86_64/extra.db.tar.gz

package graph

Links come from deterministic package relationships, av.db category and tag curation, ecosystem matches, and package hub membership.

source trail

Generated from repository data

This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.

Combined YAML source

View the package source record on GitHub.

combined/openapi-diff.yml

Used sources

Geiger risk classifier
Nucleus package database
av.db category and tag curation
cross-ecosystem install command graph
curated package history
external package-manager database matches
package relationship graph
package version freshness
package-page enrichment

Install openapi-diff with Homebrew, pacman