Api Changelog Versioning
- 314 installs
- 202 repo stars
- Updated August 4, 2026
- secondsky/claude-skills
api-changelog-versioning is an MIT-licensed skill that creates comprehensive API changelogs documenting breaking changes, deprecations, and migration strategies for developers communicating version upgrades to API consum
About
api-changelog-versioning is a secondsky/claude-skills package that produces structured API changelogs for version releases. Each entry documents breaking changes, deprecations with timelines, and step-by-step migration instructions—for example switching authentication from API tokens to JWT Bearer or adopting JSON:API response formats. The skill follows a semver-oriented changelog structure with dated version headers, categorized change lists, and numbered migration steps such as updating base URLs to `/api/v3`. A developer reaches for api-changelog-versioning when releasing a major API version and needs consumer-facing upgrade documentation that reduces integration breakage and support tickets.
- api-changelog-versioning
Api Changelog Versioning by the numbers
- 314 all-time installs (skills.sh)
- +14 installs in the week ending Aug 5, 2026 (Skillselion tracking)
- Ranked #1,300 of 4,347 Backend & APIs skills by installs in the Skillselion catalog
- Data as of Aug 5, 2026 (Skillselion catalog sync)
npx skills add https://github.com/secondsky/claude-skills --skill api-changelog-versioningAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 314 |
|---|---|
| repo stars | ★ 202 |
| Last updated | August 4, 2026 |
| Repository | secondsky/claude-skills ↗ |
How do you document API breaking changes for consumers?
Use api-changelog-versioning for development tasks
Who is it for?
API maintainers shipping semver releases who need structured changelogs with breaking-change callouts and migration paths.
Skip if: Teams designing initial API versioning strategy before any releases exist—use api-versioning-strategy first.
When should I use this skill?
The user asks to write an API changelog, document breaking changes, or create upgrade guides for API consumers.
What you get
Versioned API changelog, deprecation notices, and step-by-step consumer migration guide
- API changelog markdown
- migration guide
- deprecation notices
By the numbers
- MIT-licensed skill from secondsky/claude-skills
- Changelog template includes Breaking Changes, Deprecations, and Migration Steps sections
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 suggestionsDeprecation 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 productionBest 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
Related skills
Lark Openapi ExplorerInstantly explore, test, and generate calls against the full Lark (Feishu) OpenAPI surface without leaving their agent workflow.493k
Lark EventConsume real-time events from Lark/Feishu as structured NDJSON streams inside AI agent workflows.387k16kLark Openapi ExplorerWhen an existing Lark/Feishu skill or CLI command cannot fulfill a specific requirement and they need to discover and invoke the exact native OpenAPI endpoint.386k16k
Just ScrapeQuickly search, crawl, extract structured JSON, or monitor web pages without writing custom scraping code.245k41Lark AppsQuery the current visibility and permission scope of a Lark (Feishu) app without writing HTTP client code.235k16k
Design An InterfaceGenerate multiple radically different interface or API designs in parallel before committing to one.188k198kHow it compares
Choose api-changelog-versioning after api-versioning-strategy when the version scheme exists and you need consumer-facing release notes.
FAQ
What does api-changelog-versioning document?
api-changelog-versioning documents breaking changes, deprecations with timelines, and numbered migration steps in a semver changelog. Examples include JWT auth replacements and JSON:API response format shifts per release.
When should api-changelog-versioning be invoked?
api-changelog-versioning should run when managing API versions, communicating breaking changes to consumers, or creating upgrade guides before or during a major API release ship.