mcpbeat

API Changelog Versioning

secondsky/api-changelog-versioning

Creates comprehensive API changelogs documenting breaking changes, deprecations, and migration strategies for API consumers. Use when managing API versions, communicating breaking changes, or creating upgrade guides.

This is a copy. The original lives at comeonoliver/api-changelog-versioning.

496 tokens
context cost
the whole folder, loaded on every use
1
files
instructions only
0
copies elsewhere
how many repositories repackaged it
202
stars on the repo
on the repository, not the skill itself

Install

one command, takes just this skill from the repository 
npx skills add https://github.com/secondsky/claude-skills --skill api-changelog-versioning

The instruction itself

6 sections, as written by the author

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

| Version | Status | Support Until |

|---------|--------|---------------|

| v3.x | Current | Full support |

| v2.x | Maintenance | 2025-06-01 |

| v1.x | EOL | Unsupported |

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)

{ "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

How to use it

Copy the folder

Take secondsky/api-changelog-versioning from the repository into ~/.claude/skills for personal use, or into .claude/skills inside a project.

Check the name does not clash

The agent identifies a skill by the name field in its header. Two skills with the same name cannot sit side by side — one of them will be ignored.