Detect breaking API changes on every pull request. Severity-graded PR comments with migration guides. Two lines of YAML. Free.
Compares the spec in the PR against the spec on the base branch (main/master). Detects 27 types of changes including endpoint removals, type changes, enum value removals, and new required parameters.
Every change is classified as breaking or non-breaking, with severity badges. Breaking changes include step-by-step migration guides so developers know exactly what to fix.
Returns exit code 1 when policy violations are found. Combined with branch protection rules, this prevents breaking changes from ever reaching production.
Automatically classifies whether the changes require a MAJOR, MINOR, or PATCH version bump so your release process stays consistent.
Add this to any workflow file in .github/workflows/
name: API Governance
on:
pull_request:
paths:
- 'api/**'
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: delimit-ai/delimit-action@v1
with:
spec: api/openapi.yamlOr the minimal version if you already have a workflow:
- uses: delimit-ai/delimit-action@v1
with:
spec: api/openapi.yamlThis is what Delimit posts on your pull request when it detects changes.
/users was removed/v2/users was added| Input | Required | Default | Description |
|---|---|---|---|
| spec | Yes | -- | Path to your OpenAPI spec file |
| policy | No | default | Policy preset: strict, default, or relaxed |
| base_ref | No | auto | Base branch to compare against |
| fail_on_breaking | No | true | Whether to fail the check on breaking changes |
Two lines of YAML. No config. No API keys. Breaking changes blocked before merge.