Stats
Actions
Tags
Help us improve
Share bugs, ideas, or general feedback.
Generates API changelogs with breaking changes, deprecations, migration guides, version policies, and deprecation schedules. Use for API versioning, upgrade docs, and change communication.
npx claudepluginhub secondsky/claude-skills --plugin api-changelog-versioningHow this skill is triggered — by the user, by Claude, or both
Slash command
/api-changelog-versioning:api-changelog-versioningThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Document API changes with clear migration paths and deprecation timelines.
Produces a complete API versioning strategy with scheme selection, breaking-change classification, deprecation timeline, migration guide, and client communication templates for REST, GraphQL, or gRPC.
Designs an API versioning policy (URL path, date-based, or header versioning) to evolve APIs without breaking existing consumers. Includes breaking vs. non-breaking change rules and version lifecycle policies.
Guides API versioning strategies including URL path, header, query parameter, and content negotiation. Helps manage breaking changes, deprecations, and multiple versions.
Share bugs, ideas, or general feedback.
Document API changes with clear migration paths and deprecation timelines.
# 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
| Version | Status | Support Until |
|---|---|---|
| v3.x | Current | Full support |
| v2.x | Maintenance | 2025-06-01 |
| v1.x | EOL | Unsupported |
## Migrating from v2 to v3
### Before (v2)
```json
{ "user_name": "john" }
{ "data": { "type": "user", "attributes": { "name": "john" } } }
## 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