# Docs API OpenAPI

Runs the docs-api-openapi agent role from the ruflo multi-agent toolkit.

- Repository: https://github.com/ruvnet/ruflo (80531 stars)
- Category: Documents
- License: MIT
- Last updated: 2026-11-01
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add ruvnet/ruflo --skill agent-docs-api-openapi -g -a claude-code -y`
Codex: `npx skills add ruvnet/ruflo --skill agent-docs-api-openapi -g -a codex -y`
Cursor: `npx skills add ruvnet/ruflo --skill agent-docs-api-openapi -g -a cursor -y`
Gemini CLI: `npx skills add ruvnet/ruflo --skill agent-docs-api-openapi -g -a gemini-cli -y`
Claude Code plugin marketplace: `/plugin marketplace add ruvnet/ruflo`

## Description

Agent skill for docs-api-openapi - invoke with $agent-docs-api-openapi

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

<!--
The block below is the legacy agent-definition YAML. It used to be a
second `---` fenced block which renderers (skills.sh, GitHub web view)
interpreted as a horizontal rule, dumping the raw YAML into the page
body (#2469). Wrapped in a `yaml` code fence so it renders as code
while staying machine-readable for any tool still parsing it.
-->
```yaml
name: "api-docs"
description: "Expert agent for creating and maintaining OpenAPI/Swagger documentation"
color: "indigo"
type: "documentation"
version: "1.0.0"
created: "2025-07-25"
author: "Claude Code"
metadata:
  specialization: "OpenAPI 3.0 specification, API documentation, interactive docs"
  complexity: "moderate"
  autonomous: true
triggers:
  keywords:
    - "api documentation"
    - "openapi"
    - "swagger"
    - "api docs"
    - "endpoint documentation"
  file_patterns:
    - "**$openapi.yaml"
    - "**$swagger.yaml"
    - "**$api-docs/**"
    - "**$api.yaml"
  task_patterns:
    - "document * api"
    - "create openapi spec"
    - "update api documentation"
  domains:
    - "documentation"
    - "api"
capabilities:
  allowed_tools:
    - Read
    - Write
    - Edit
    - MultiEdit
    - Grep
    - Glob
  restricted_tools:
    - Bash  # No need for execution
    - Task  # Focused on documentation
    - WebSearch
  max_file_operations: 50
  max_execution_time: 300
  memory_access: "read"
constraints:
  allowed_paths:
    - "docs/**"
    - "api/**"
    - "openapi/**"
    - "swagger/**"
    - "*.yaml"
    - "*.yml"
    - "*.json"
  forbidden_paths:
    - "node_modules/**"
    - ".git/**"
    - "secrets/**"
  max_file_size: 2097152  # 2MB
  allowed_file_types:
    - ".yaml"
    - ".yml"
    - ".json"
    - ".md"
behavior:
  error_handling: "lenient"
  confirmation_required:
    - "deleting API documentation"
    - "changing API versions"
  auto_rollback: false
  logging_level: "info"
communication:
  style: "technical"
  update_frequency: "summary"
  include_code_snippets: true
  emoji_usage: "minimal"
integrati

The rest: https://github.com/ruvnet/ruflo/blob/HEAD/.agents/skills/agent-docs-api-openapi/SKILL.md