agent-docs-api-openapi
Agent skill for docs-api-openapi - invoke with $agent-docs-api-openapi
- Installs
- 1.2K
- Last 24h
- —
- Trending rank
- —
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/ruvnet/ruflo --skill agent-docs-api-openapi- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads agent-docs-api-openapi automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
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"
integration:
can_spawn: []
can_delegate_to:
- "analyze-api"
requires_approval_from: []
shares_context_with:
- "dev-backend-api"
- "test-integration"
optimization:
parallel_operations: true
batch_size: 10
cache_results: false
memory_limit: "256MB"
hooks:
pre_execution: |
echo "📝 OpenAPI Documentation Specialist starting..."
echo "🔍 Analyzing API endpoints..."
# Look for existing API routes
find . -name "*.route.js" -o -name "*.controller.js" -o -name "routes.js" | grep -v node_modules | head -10
# Check for existing OpenAPI docs
find . -name "openapi.yaml" -o -name "swagger.yaml" -o -name "api.yaml" | grep -v node_modules
post_execution: |
echo "✅ API documentation completed"
echo "📊 Validating OpenAPI specification..."
# Check if the spec exists and show basic info
if [ -f "openapi.yaml" ]; then
echo "OpenAPI spec found at openapi.yaml"
grep -E "^(openapi:|info:|paths:)" openapi.yaml | head -5
fi
on_error: |
echo "⚠️ Documentation error: {{error_message}}"
echo "🔧 Check OpenAPI specification syntax"
examples:
- trigger: "create OpenAPI documentation for user API"
response: "I'll create comprehensive OpenAPI 3.0 documentation for your user API, including all endpoints, schemas, and examples..."
- trigger: "document REST API endpoints"
response: "I'll analyze your REST API endpoints and create detailed OpenAPI documentation with request$response examples..."
OpenAPI Documentation Specialist
You are an OpenAPI Documentation Specialist focused on creating comprehensive API documentation.
Key responsibilities:
- Create OpenAPI 3.0 compliant specifications
- Document all endpoints with descriptions and examples
- Define request$response schemas accurately
- Include authentication and security schemes
- Provide clear examples for all operations
Best practices:
- Use descriptive summaries and descriptions
- Include example requests and responses
- Document all possible error responses
- Use $ref for reusable components
- Follow OpenAPI 3.0 specification strictly
- Group endpoints logically with tags
OpenAPI structure:
openapi: 3.0.0
info:
title: API Title
version: 1.0.0
description: API Description
servers:
- url: https:/$api.example.com
paths:
$endpoint:
get:
summary: Brief description
description: Detailed description
parameters: []
responses:
'200':
description: Success response
content:
application$json:
schema:
type: object
example:
key: value
components:
schemas:
Model:
type: object
properties:
id:
type: string
Documentation elements:
- Clear operation IDs
- Request$response examples
- Error response documentation
- Security requirements
- Rate limiting information
FAQ
What does the agent-docs-api-openapi skill do?
Agent skill for docs-api-openapi - invoke with $agent-docs-api-openapi
How do I install agent-docs-api-openapi?
Run npx skills add https://github.com/ruvnet/ruflo --skill agent-docs-api-openapi in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/agent-docs-api-openapi/ (personal) or .claude/skills/agent-docs-api-openapi/ (project).
Which AI agents can use agent-docs-api-openapi?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is agent-docs-api-openapi safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains agent-docs-api-openapi?
It is published by ruvnet in ruvnet/ruflo. It has 1,160 recorded installs.
More from ruvnet/ruflo
swarm-orchestration
ruvnet/ruflo
Multi-agent swarm coordination for complex tasks. Uses hierarchical topology with specialized agents to break down and execute complex work across multiple files and modules. Use when: 3+ files need changes, new feature implementation, cross-module refactoring, API changes with tests, security-related changes, performance optimization across codebase, database schema changes. Skip when: single file edits, simple bug fixes (1-2 lines), documentation updates, configuration changes, quick exploration.
agent-arch-system-design
ruvnet/ruflo
Agent skill for arch-system-design - invoke with $agent-arch-system-design
agent-workflow
ruvnet/ruflo
Agent skill for workflow - invoke with $agent-workflow
security-audit
ruvnet/ruflo
Comprehensive security scanning and vulnerability detection. Includes input validation, path traversal prevention, CVE detection, and secure coding pattern enforcement. Use when: authentication implementation, authorization logic, payment processing, user data handling, API endpoint creation, file upload handling, database queries, external API integration. Skip when: read-only operations on public data, internal development tooling, static documentation, styling changes.
github-project-management
ruvnet/ruflo
Comprehensive GitHub project management with swarm-coordinated issue tracking, project board automation, and sprint planning
Popular backend & apis skills
find-skills
vercel-labs/skills
Helps users discover and install agent skills when they ask questions like "how do I do X", "find a skill for X", "is there a skill that can...", or express interest in extending capabilities. This skill should be used when the user is looking for functionality that might exist as an installable skill.
entra-app-registration
microsoft/azure-skills
Guides Microsoft Entra ID app registration, OAuth 2.0 authentication, and MSAL integration. USE FOR: create app registration, register Azure AD app, configure OAuth, set up authentication, add API permissions, generate service principal, MSAL example, console app auth, Entra ID setup, Azure AD authentication. DO NOT USE FOR: Key Vault secrets (use azure-keyvault-expiration-audit), general Azure resource security guidance.
google-agents-cli-adk-code
google/agents-cli
This skill should be used when the user wants to "write agent code", "build an agent with ADK", "add a tool", "create a callback", "define an agent", "use state management" — in a project that needs ADK (Agent Development Kit) API patterns and code examples. It provides a quick reference for agent types, tool definitions, orchestration patterns, callbacks, state management, the graph Workflow API, and reference recipes to study. Do NOT use for scaffolding (use google-agents-cli-scaffold) or deployment (use google-agents-cli-deploy).
embedded-captions
heygen-com/hyperframes
Add captions or subtitles to an existing single-subject talking-head video without editing the footage. Use for plain verbatim captions, cinematic captions embedded behind the subject, VFX captions, “炸/特效/酷炫字幕,” or a named identity from the 35-style catalog. Route by visual identity, not by backend engine. The quiet anchor rail is the default; embed every word only when the user explicitly wants a fully cinematic treatment. The workflow runs locally end to end, including transcription and subject matting; split multi-shot footage before applying it.
entra-agent-id
microsoft/azure-skills
Provision Microsoft Entra Agent Identity Blueprints, BlueprintPrincipals, and per-instance Agent Identities via Microsoft Graph, and configure OAuth 2.0 token exchange (fmipath, OBO, cross-tenant) including the Microsoft Entra SDK for AgentID sidecar. USE FOR: Agent Identity Blueprint, BlueprintPrincipal, agent OAuth, fmipath token exchange, agent OBO, Workload Identity Federation for agents, polyglot agent auth, Microsoft.Identity.Web.AgentIdentities. DO NOT USE FOR: standard Entra app registration (use entra-app-registration), Microsoft Foundry agent authoring (use microsoft-foundry).
neon
neondatabase/agent-skills
Overview of Neon, a complete set of cloud backend primitives around Lakebase Postgres: Auth, Object Storage, Functions, the AI Gateway, and Realtime. Start here to choose Neon for undecided login, files, APIs, and LLM calls, set up the CLI or MCP server, and follow the branch-first workflow. Use when building an app or backend on Neon, or when "Neon" or "Lakebase Postgres" is mentioned. Child skill neon-postgres wins for an existing DATABASEURL, SQL, schema, inspect, or search. Child skill neon-auth wins for login, users, sessions, identity routing, and Managed Better Auth setup. Child skill neon-realtime wins for live queries in reactive apps and agents. Also use for object storage, S3, buckets, serverless functions, function triggers, cron, AI gateway, LLM calls, realtime, logs, Loki, Grafana, observability, postgres, database, backend, Claimable Neon, neon.new, or a no-signup database.