Menu
Creates or reviews API documentation for endpoints, SDKs, schemas, examples, errors, authentication, and compatibility behavior.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Creates or reviews API documentation for endpoints, SDKs, schemas, examples, errors, authentication, and compatibility behavior.
Diagnoses CI/CD failures from logs and workflow files, identifies likely root cause, and recommends minimal fixes or retry guidance.
Reviews code changes for quality, correctness, style, and potential issues.
Audits dependency files and package changes for vulnerable packages, risky upgrades, license concerns, and supply-chain exposure.
Reviews Dockerfiles and container configuration for security, reproducibility, image size, runtime permissions, and deployment reliability.
Plans safe framework, library, API, database, or architecture migrations with phased rollout, compatibility checks, and rollback strategy.
| name | api-documentation |
| display_name | API Documentation |
| description | Creates or reviews API documentation for endpoints, SDKs, schemas, examples, errors, authentication, and compatibility behavior. |
| category | documentation |
| version | 1.0.0 |
| tags | ["api","documentation","openapi","sdk","examples"] |
| providers | ["claude-code","codex","copilot","openclaw","hermes-agent"] |
| author | agent-skills contributors |
Use this skill when writing, reviewing, or improving documentation for HTTP APIs, SDK methods, schemas, webhooks, or integrations.
Return:
