Skip to content

a5c-ai/babysitter / library/specializations/code-migration-modernization/skills/api-compatibility-analyzer

api-compatibility-analyzer

Verified

Analyze API changes for backward compatibility with breaking change detection and consumer impact assessment

FileKindSize
README.mdmarkdown1.5 KB
SKILL.mdskill md2.8 KB
# API Compatibility Analyzer Skill

## Overview

The API Compatibility Analyzer skill detects breaking changes between API versions. It assesses consumer impact and recommends migration strategies.

## Quick Start

### Prerequisites

- OpenAPI specs for both versions
- Consumer inventory (optional)
- Comparison tooling

### Basic Usage

1. **Compare versions**
   ```bash
   # Using openapi-diff
   openapi-diff v1/openapi.yaml v2/openapi.yaml
   ```

2. **Review breaking changes**
   - Removed endpoints
   - Type changes
   - Required field additions

3. **Plan migration**
   - Assess impact
   - Design compatibility layer
   - Communicate to consumers

## Features

### Change Categories

| Category | Breaking | Example |
|----------|----------|---------|
| Endpoint removed | Yes | DELETE /users/{id} |
| Field removed | Yes | Remove `email` from response |
| Type changed | Yes | string -> integer |
| Field added (optional) | No | Add `nickname` |
| Endpoint added | No | POST /users/bulk |

### Impact Levels

- Critical: All consumers affected
- High: Many consumers affected
- Medium: Some consumers affected
- Low: Few consumers affected

## Configuration

```json
{
  "base": {
    "spec": "./api/v1/openapi.yaml"
  },
  "target": {
    "spec": "./api/v2/openapi.yaml"
  },
  "consumers": {
    "inventory": "./consumers.json"
  },
  "rules": {
    "allowFieldRemoval": false,
    "allowTypeChanges": false
  }
}
```

## Related Documentation

- [SKILL.md](./SKILL.md) - Full skill specification
- [OpenAPI-diff](https://github.com/OpenAPITools/openapi-diff)
receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementationStars: 322kUpdated Claude CodeCodexVerifiedInstall
requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirementsStars: 322kUpdated Claude CodeCodexVerifiedInstall
using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallbackStars: 322kUpdated Claude CodeCodexVerifiedInstall
verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions alwaysStars: 322kUpdated Claude CodeCodexVerifiedInstall