Skip to content

Latest commit

 

History

10 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

Delimit Demo

Live demonstration of Delimit catching breaking API changes on a real pull request.

What This Demonstrates

A Users API (openapi.yaml) gets a v2 migration PR that introduces 6 breaking changes:

Breaking Change Severity
Required tenant_id header added to GET /users High
DELETE /users/{userId} removed Critical
userId type changed from string to integer Warning
User.id type changed from string to integer Warning
Required tenant_id field added to User schema High
editor removed from role enum Warning

Plus 1 safe additive change: new GET /v2/users endpoint.

See It In Action

View the PR with Delimit's comment →

The PR comment includes:

  • Breaking changes table with severity badges
  • Semver classification (MAJOR: 1.0.0 → 2.0.0)
  • 6-step migration guide
  • New additions list

Try It Yourself

Add Delimit to any repo with an OpenAPI spec:

- uses: delimit-ai/delimit-action@v1
  with:
    spec: path/to/openapi.yaml

About

Live demo: Delimit Action catches 23 breaking changes across 27 detection types on a real PR.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors