Skip to content

Migrate Pet Store API to v2#1

Open
infracore wants to merge 2 commits intomainfrom
demo/breaking-change
Open

Migrate Pet Store API to v2#1
infracore wants to merge 2 commits intomainfrom
demo/breaking-change

Conversation

@infracore
Copy link
Copy Markdown
Member

Changes

  • Remove DELETE /pets/{petId} endpoint (replaced with PATCH)
  • Change Pet.id type from string to integer
  • Remove pending from Pet.status enum
  • Update workflow to use spec auto-fetch mode

This PR intentionally introduces breaking changes to demonstrate Delimit's detection capabilities.

infracore added 2 commits March 20, 2026 13:47
- Remove DELETE /pets/{petId} (replaced with PATCH)
- Change Pet.id type from string to integer
- Remove 'pending' enum value from Pet.status
- Update workflow to use spec auto-fetch mode
@infracore infracore closed this Mar 20, 2026
@infracore infracore reopened this Mar 20, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 20, 2026

🔴 MAJOR — Breaking Changes Detected

3 changes · 3 breaking · next: 2.0.0

Breaking Changes

Change Location Severity
Method DELETE cannot be removed from /pets/{petId} /pets/{petId}:DELETE 🔴 Critical
Type changed from string to integer at #/components/schemas/Pet.id #/components/schemas/Pet.id 🟡 Warning
📋 Migration guide

Migration Guide: Pet Store API (1.0.0 -> 2.0.0)

This release contains 3 breaking change(s).
Follow the steps below to update your integration.

Step 1: Method Removed

Change: Method removed: DELETE /pets/{petId}
Location: /pets/{petId}:DELETE

Action: Update clients using this HTTP method. Check if an alternative method is available on the same path.

Step 2: Type Changed

Change: Type changed from string to integer at #/components/schemas/Pet.id
Location: #/components/schemas/Pet.id

Action: Update serialization/deserialization logic for the new type. Check all type assertions, validators, and database column types.

Step 3: Enum Value Removed

Change: Enum value 'pending' removed at #/components/schemas/Pet.status
Location: #/components/schemas/Pet.status

Action: Stop sending the removed enum value. Update any switch/case or if/else blocks that handle it.


After completing all steps, run your integration tests to verify.


Delimit · API governance for CI/CD

@infracore infracore closed this Mar 21, 2026
@infracore infracore reopened this Mar 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant