aj-geddes avatar

Api Changelog Versioning

Helps you write comprehensive API changelogs with breaking changes, migration guides, and version comparisons. You'd use this when shipping a new API version, deprecating endpoints, or changing authentication methods. It gives you templates for before/after code examples, deprecation timelines, and step-by-step migration instructions. The reference guides cover breaking changes, new features, security updates, and version support policies. Honestly, the structured approach here is what most teams skip when they're rushing to ship, then they pay for it in support tickets. The emphasis on 3-6 month deprecation windows and backward compatibility feels right for any production API.

skills.sh installs
477
GitHub stars
379
last updated
Aug 21, 2026

Install

$ npx -y skills add aj-geddes/useful-ai-prompts --skill api-changelog-versioning --agent claude-code

Installs into .claude/skills of the current project.

Files

API Changelog & Versioning

Table of Contents

Overview

Create comprehensive API changelogs that document changes, deprecations, breaking changes, and provide migration guides for API consumers.

When to Use

  • API version changelogs
  • Breaking changes documentation
  • Migration guides between versions
  • Deprecation notices
  • API upgrade guides
  • Backward compatibility notes
  • Version comparison

Quick Start

  • Version comparison
# API Changelog

## Version 3.0.0 - 2025-01-15

### 🚨 Breaking Changes

#### Authentication Method Changed

**Previous (v2):**

```http
GET /api/users
Authorization: Token abc123
```

## Reference Guides

Detailed implementations in the `references/` directory:

Sponsors

Details

Repository
github.com/aj-geddes/useful-ai-prompts
Categories
Backend & APIs, Git & Pull Requests, AI & Agent Building, Release Management
First seen
Jun 3, 2026

More from aj-geddes/useful-ai-prompts

All 258
1aj-geddes avatardatabase-monitoringaj-geddes/useful-ai-promptsMonitor database performance and health. Use when setting up monitoring, analyzing metrics, or troubleshooting database issues.467skills.sh installs
2auth0 avatarauth0-fastapi-apiauth0/agent-skillsUse when protecting FastAPI endpoints with JWT Bearer token validation, scope checks, or DPoP binding. Integrates auth0-fastapi-api for stateless APIs receiving461skills.sh installs
3aj-geddes avatarapi-filtering-sortingaj-geddes/useful-ai-promptsImplement advanced filtering and sorting capabilities for APIs with query parsing, field validation, and optimization. Use when building search features, comple450skills.sh installs
4aj-geddes avatardatabase-shardingaj-geddes/useful-ai-promptsImplement database sharding for horizontal scalability. Use when scaling large databases, distributing data across multiple servers, or designing sharded archit446skills.sh installs
5bobmatnyc avatarhono-middlewarebobmatnyc/claude-mpm-skillsHono middleware patterns - creation, composition, built-in middleware, and execution order for web applications444skills.sh installs
6sickn33 avatardatabase-optimizersickn33/antigravity-awesome-skillsdatabase optimizer436skills.sh installs