// Create or update OpenAPI specifications and API documentation for Apify endpoints. Use when user says "add API endpoint", "create OpenAPI spec", "document this endpoint", "add code samples for API", "update API docs", or "api-doc". Handles OpenAPI YAML, schemas, code samples, and operation IDs.
Write or edit Apify documentation pages following the style guide. Use when user says "write docs for", "create a new page", "document this feature", "add documentation about", "edit this doc page", or "write a guide for [topic]". Handles platform docs, guides, and reference pages with proper formatting and structure.
Review Apify documentation for style guide compliance, quality standards, and best practices. Use when user says "review this doc", "check this page", "audit documentation", "review before PR", "is this ready to publish", or "review-docs". Runs automated checks and manual review against Apify style guide.
Create structured tutorials for Apify Academy or Platform documentation. Use when user says "create a tutorial", "write a tutorial", "build a step-by-step guide", "convert this guide into a tutorial", or "tutorial for [topic]". Handles tutorial structure, learning objectives, prerequisites, step-by-step instructions, code examples, and troubleshooting sections.
| name | api-doc |
| description | Create or update OpenAPI specifications and API documentation for Apify endpoints. Use when user says "add API endpoint", "create OpenAPI spec", "document this endpoint", "add code samples for API", "update API docs", or "api-doc". Handles OpenAPI YAML, schemas, code samples, and operation IDs. |
| allowed-tools | Read Write Edit Bash Glob Grep |
| argument-hint | endpoint-name |
apify-api/openapi/paths/apify-api/openapi/components/schemas/apify-api/openapi/code_samples/{javascript,curl}// with @ (e.g., request-queues@{queueId}.yaml){objectName}_{httpMethod} in camelCaseoperationId$ref to apify-api/openapi/openapi.yamlpnpm openapi:lint then pnpm api:rebuildCRITICAL: API docs are generated, not hand-written. Never edit files in apify-api/docs/ directly.
For detailed patterns and examples, see .agents/skills/api-doc/references/openapi-patterns.md.
For edge cases and process notes, see .agents/skills/api-doc/references/process.md.