api-documentation

npx skills add majiayu000/claude-skill-registry --skill api-documentation-troykelly-codex-skills-2 --agent codex

Same command for any agent — swap --agent for claude-code, cursor, copilot.

# API Documentation Enforcement ## Overview Ensures all API changes are reflected in Swagger/OpenAPI documentation. When documentation drift is detected, work pauses until documentation is synchronized. **Core principle:** API documentation is a first-class artifact, not an afterthought. No API change ships without documentation. **Announce at start:** "I'm using api-documentation to verify Swagger/OpenAPI sync." ## When This Skill Triggers This skill is triggered when ANY of these file patterns are modified: | Pattern | Framework | Trigger Reason | |---------|-----------|----------------| | `**/routes/**/*.ts` | Express/Fastify | Route definitions | | `**/controllers/**/*.ts` | NestJS/Express | Controller endpoints | | `**/*.controller.ts` | NestJS | Controller class | | `**/api/**/*.py` | FastAPI/Flask | API endpoints | | `**/*_router.py` | FastAPI | Router definitions | | `**/handlers/**/*.go` | Go | HTTP handlers | | `**/schema*.ts` | TypeScript | Schema definitions | | `**/dto/**/*.ts` | NestJS | Data transfer objects | | `**/models/**/*.ts` | Various | API models | ## Documentation Locations Check these locations for existing API documentation: | File | Format | Standard | |-

Check if current changes affect API
Check common API file patterns
for pattern in "routes/" "controllers/" "api/" "handlers/" "*.controller.ts" "*_router.py"; do
if git diff --name-only HEAD~1 | grep -q "$pattern"; then
break
fi
done
Check for schema/DTO changes
if git diff --name-only HEAD~1 | grep -qE "(schema|dto|model)"; then
echo "API Changed: $API_CHANGED"