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.2

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.2
File Size Uploaded Provenance Actions
api_diff_sentinel-1.0.2.tar.gz 3.8 kB Without provenance Details for api_diff_sentinel-1.0.2.tar.gz

Built distribution (wheel)

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

Total release size: 8.7 kB

Release files / api_diff_sentinel-1.0.2.tar.gz

Download URL api_diff_sentinel-1.0.2.tar.gz
Size 3.8 kB
Tags Source
SHA-256 checksum
How to use checksums
c0d017f9f1722c5d5954960464d354456ca744eb26724f36fa4bbc29f5ed6759
BLAKE2b-256 checksum
How to use checksums
a303ac91b0b978905af147cd01c1162921d6e3a1232380d256ef9aa7b00c11fb
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.2-py3-none-any.whl

Download URL api_diff_sentinel-1.0.2-py3-none-any.whl
Size 4.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
44ef650d10d88721643f8db71c2136872a93b8f80b0d3b41c7fd0b00dedcc5f4
BLAKE2b-256 checksum
How to use checksums
3e3cb2f4dda591a180eeeda9c28232a7a0a351932c9792f1e5b6805ead73fd6d
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.2

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