Skip to main content

api-diff-sentinel

Compare two OpenAPI specs (JSON) and report breaking vs non-breaking changes. Built for CI.

pip install api-diff-sentinel
api-diff old-openapi.json new-openapi.json
api-diff old.json new.json --fail-on-breaking   # exit code 1 if breaking
api-diff old.json new.json --json               # machine-readable

Example output

Verdict: BREAKING CHANGES DETECTED
  Removed endpoint: `/v1/orders`
  Added new required parameter `org_id` to `GET /v1/users` (Breaking)
  Added new endpoint: `/v1/products`

GitHub Actions

- run: pip install api-diff-sentinel
- run: api-diff base/openapi.json head/openapi.json --fail-on-breaking

What it detects

Breaking: removed endpoints, removed methods, removed parameters, new required parameters. Non-breaking: new endpoints, new methods, new optional parameters.

Limitations (v1)

  • Compares paths, methods and parameters only. It does not yet diff request/response schemas, types, enums or auth.
  • JSON specs only (convert YAML first); $ref parameters are not resolved.

MIT licensed.

Metadata

Release files for api-diff-sentinel 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for api-diff-sentinel 1.0.1
File Size Uploaded Provenance Actions
api_diff_sentinel-1.0.1.tar.gz 3.7 kB Without provenance Details for api_diff_sentinel-1.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for api-diff-sentinel 1.0.1
File Interpreter ABI Platform Actions
api_diff_sentinel-1.0.1-py3-none-any.whl Python 3 none any Details for api_diff_sentinel-1.0.1-py3-none-any.whl

Total release size: 8.5 kB

Release files / api_diff_sentinel-1.0.1.tar.gz

Download URL api_diff_sentinel-1.0.1.tar.gz
Size 3.7 kB
Tags Source
SHA-256 checksum
How to use checksums
a5e471e0a59fffb84f28e85e37a4dda5cbbbc13286f5dc7542e083391d57db77
BLAKE2b-256 checksum
How to use checksums
d4752babf0a2eae68c80a38092ea45347226047a2bd6818877460595f0a3a92b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.17 {"installer":{"name":"uv","version":"0.12.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / api_diff_sentinel-1.0.1-py3-none-any.whl

Download URL api_diff_sentinel-1.0.1-py3-none-any.whl
Size 4.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bac0ce297e3834fb1897bcb1b5752516eb4aff0918c1d44e203e9942919b9df5
BLAKE2b-256 checksum
How to use checksums
e368186e2e15d7562cc729d1184609e51ce32cb9f42318016006b2b137c5afb4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.17 {"installer":{"name":"uv","version":"0.12.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for api-diff-sentinel 1.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page