secondsky/api-changelog-versioning
plugins/api-changelog-versioning/skills/api-changelog-versioning/SKILL.md
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.
$ install --global
skillsauthnpx skillsauth add secondsky/claude-skills api-changelog-versioningInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: May 15, 2026, 4:26 AM10.1s1 file scanned
SKILL.md
- name:
- api-changelog-versioning
- description:
- 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.
- license:
- MIT
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)
```json
{ "user_name": "john" }
After (v3)
{ "data": { "type": "user", "attributes": { "name": "john" } } }
Steps
- Update SDK to v3.x
- Modify response handlers
- Test in staging environment
- 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
Related Skills
secondsky/bun-runtime
tools
VerifiedTrustedCommunity
Use for Bun runtime, bunfig.toml, watch/hot modes, env vars, CLI flags, and module resolution.
144SKILL.mdUpdated May 15, 2026
secondsky/bun-redis
data-ai
VerifiedTrustedCommunity
Use when working with Redis in Bun (ioredis, Upstash), caching, pub/sub, session storage, or key-value operations.
144SKILL.mdUpdated May 15, 2026
secondsky/bun-react-ssr
development
VerifiedTrustedCommunity
Use when building server-rendered React with Bun, including streaming SSR, hydration, renderToString, or custom SSR without a framework.
144SKILL.mdUpdated May 15, 2026
secondsky/bun-package-manager
databases
VerifiedTrustedCommunity
Bun package manager commands (install, add, remove, update), workspaces, lockfiles, npm/yarn/pnpm migration. Use for dependency management with Bun.
144SKILL.mdUpdated May 15, 2026