| 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. Use when this capability is needed. |
| metadata | {"author":"apify"} |
API documentation
Process
- Identify change type - new endpoint, update endpoint, add code samples, or new schema
- Follow OpenAPI file structure:
- Paths in
apify-api/openapi/paths/
- Schemas in
apify-api/openapi/components/schemas/
- Code samples in
apify-api/openapi/code_samples/{javascript,curl}/
- Create or update files using naming conventions:
- Path files: replace
/ with @ (e.g., request-queues@{queueId}.yaml)
- Operation IDs:
{objectName}_{httpMethod} in camelCase
- Code sample filenames must match
operationId
- Register in main spec - add path
$ref to apify-api/openapi/openapi.yaml
- Validate -
pnpm openapi:lint then pnpm api:rebuild
CRITICAL: 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.
Source: apify/apify-docs — distributed by TomeVault.
