Demo: Catch Breaking API Changes in 60 Seconds

This repo has 3 intentional breaking changes between openapi-v1.yaml (the baseline) and openapi.yaml (the current spec). Let's catch them.

The breaking changes hidden in this repo

1. Removed endpoint -- DELETE /items/{id} was deleted
2. Renamed field -- name was renamed to title in the response schema
3. Changed parameter type -- id path parameter changed from integer to string

Try it

# Install and run in one command
npx delimit-cli lint --old openapi-v1.yaml --new openapi.yaml

That's it. Delimit found 3 breaking changes, classified the semver impact as MAJOR, and generated migration guidance.

Add to CI

Drop this into .github/workflows/api-check.yml (already included in this repo):

name: API Governance
on: pull_request
jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: delimit-ai/delimit-action@v1

Every pull request that touches an OpenAPI spec will now be checked for breaking changes automatically.

What Delimit detects

• Removed endpoints, fields, or parameters
• Type changes (integer to string, etc.)
• Renamed fields and endpoints
• Required field additions
• Response schema narrowing
• 27 change types total, with semver classification

Learn more

• Documentation
• GitHub Action
• npm package