secondsky avatar

Api Changelog Versioning

This generates structured API changelogs with migration guides when you're shipping breaking changes or deprecating endpoints. It templates out version announcements with before/after code examples, deprecation timelines, and step-by-step migration paths. The format is straightforward: breaking changes up top, support policy in a table, and actual code diffs showing what developers need to change. Useful if you're maintaining multiple API versions and need to communicate what's changing without leaving your users guessing. The three to six month deprecation window it suggests is reasonable, and the emphasis on concrete examples over vague notices is the right approach.

skills.sh installs
415
GitHub stars
248
last updated
Aug 21, 2026

Install

$ npx -y skills add secondsky/claude-skills --skill api-changelog-versioning --agent claude-code

Installs into .claude/skills of the current project.

Files

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

Sponsors

Details

Repository
github.com/secondsky/claude-skills
Categories
Backend & APIs, Git & Pull Requests, Release Management
First seen
Jun 3, 2026

More from secondsky/claude-skills

All 146
1secondsky avatarapi-versioning-strategysecondsky/claude-skillsImplements API versioning using URL paths, headers, or query parameters with backward compatibility and deprecation strategies. Use when managing multiple API v410skills.sh installs
2patricio0312rev avatarapi-docs-generatorpatricio0312rev/skillsGenerates API documentation using OpenAPI/Swagger specifications with interactive documentation, code examples, and SDK generation. Use when users request "API 407skills.sh installs
3martinholovsky avatarweb-audio-apimartinholovsky/claude-skills-generatorWeb Audio API for JARVIS audio feedback and voice processing406skills.sh installs
4tivojn avatargoogle-maps-apitivojn/google-maps-api-skillComplete Google Maps Platform API client - 20+ APIs including geocoding, routes, places, weather, air quality, pollen, solar, elevation, timezone, address valid403skills.sh installs
5umbraco avatarumbraco-context-apiumbraco/umbraco-cms-backoffice-skillsUnderstand and use Context API in Umbraco backoffice (foundational concept)402skills.sh installs
6sickn33 avatarvector-database-engineersickn33/antigravity-awesome-skillsvector database engineer392skills.sh installs