mcpField
A
api-changelog-versioning

api-changelog-versioning

github.com/secondskyDevelopment242410 installsUpdated 5w ago
Repository

About api-changelog-versioning

A skill for developers documenting API changes and managing compatibility. It outlines changelogs, deprecation schedules, support policies, and a migration guide template.

Key features

  1. 01Record API changes by version
  2. 02Mark breaking changes
  3. 03Set deprecation schedules
  4. 04Define version support statuses
  5. 05Provide a migration guide template

Use cases

  1. 01Publish API version change notes
  2. 02Plan deprecation and end of support for older versions
  3. 03Guide users through API response format migrations

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/secondsky/claude-skills --skill api-changelog-versioning

After installing, type/api-changelog-versioningin Claude Code to confirm it loaded.

Details

From the project README

API Changelog & Versioning

Document API changes with clear migration paths and deprecation timelines.

Changelog Structure

# API Changelog

## v3.0.0 (2025-01-15) - Breaking Changes

### Breaking Changes
- Response format now follows JSON:API specification
- Authentication switched from API tokens to JWT Bearer

### Migration Steps
1. Update base URL to `/api/v3`
2. Replace `Authorization: Token xxx` with `Authorization: Bearer xxx`
3. Update response parsing for new envelope format

## v2.5.0 (2024-12-01) - Features

### New Features
- Webhook support for order events
- Batch operations endpoint
- Field filtering via `?fields=` parameter

### Improvements
- 56% faster response times on /products
- Enhanced error messages with field-specific suggestions

Deprecation Schedule

VersionStatusSupport Until
v3.xCurrentFull support
v2.xMaintenance2025-06-01
v1.xEOLUnsupported

Version Support Policy

  • Current: Full support, new features
  • Maintenance: Bug fixes and security only
  • EOL: No support, remove from docs

Migration Guide Template

## Migrating from v2 to v3

### Before (v2)
```json
{ "user_name": "john" }
After (v3)
{ "data": { "type": "user", "attributes": { "name": "john" } } }
Steps
  1. Update SDK to v3.x
  2. Modify response handlers
  3. Test in staging environment
  4. Update production

## Best Practices

- Provide 3-6 months deprecation notice
- Include before/after code examples
- Mark breaking changes prominently
- Maintain backward compatibility when feasible
- Version via URL path (`/api/v1/`) for clarity

Comments

Markdown supported