api-doc
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.
Datos de origen
- Repositorio
- apify/apify-docs
- Última actividad en el origen
- 4 de agosto de 2026 a las 10:07
- Idioma detectado de SKILL.md
- inglés
- Estrellas
- 81
- Forks
- 239
Opciones de instalación
De forma predeterminada está seleccionado el prompt que primero revisa el origen. Puedes cambiar a un comando directo o descargar una copia local.
Revisa los archivos de origen
Lee SKILL.md y los archivos complementarios que muestra SkillsMP antes de decidir si quieres instalarlo.
Explorador de archivos
3 archivosMostrando SKILL.md
SKILL.md
Instrucciones de origen · Vista previa de solo lectura- 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
# API documentation
## Process
1. **Identify change type** - new endpoint, update endpoint, add code samples, or new schema
2. **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}/`
3. **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`
4. **Register in main spec** - add path `$ref` to `apify-api/openapi/openapi.yaml`
5. **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`.
Ver en GitHub