agent-docs-api-openapi
- Repo stars 54,444
- Author updated Live
- Author repo ruflo
- Domain
- Documentation
- Compatible agents
-
- Claude Code
- Cursor
- Cline
- Codex
- Windsurf
- Gemini CLI
- +20
- Trust score
- 88 / 100 · community maintained
- Author / version / license
- @ruvnet · no license declared
- Token usage
- Lean
- Setup complexity
- Guided setup
- External API key
- Not required
- Operating systems
- Unspecified (assume cross-platform)
- Runtime requirements
- No special requirements
- Permissions
-
- Read-only
- Write / modify
- Shell exec
- Network behavior
- Local-only
- Install commands
- 26 variants
Profile is derived at build time from SKILL.md and install vectors. Subject to drift from author intent.
Heads up: 未限定 allowed-tools,默认拥有全部工具权限。
---
name: agent-docs-api-openapi
description: Agent skill for docs-api-openapi - invoke with $agent-docs-api-openapi name: "api-docs" descript…
category: documentation
runtime: no special runtime
---
# agent-docs-api-openapi output preview
## PART A: Task fit
- Use case: Agent skill for docs-api-openapi - invoke with $agent-docs-api-openapi name: "api-docs" description: "Expert agent for creating and maintaining OpenAPI/Swagger documentation" type: "documentation" version: "1.0.0" runs entirely locally. Works with Claude Code, Cursor, Cline and 23 more..
- Inputs: target material, constraints, expected output, and acceptance criteria.
- Evidence boundary: follow “Key responsibilities: / Best practices: / OpenAPI structure:” and do not present inference as author intent.
## PART B: Execution result
- **01** The card summarizes the use case; runtime output centers on “Agent skill for docs-api-openapi - invoke with $agent-docs-api-openapi name: "api-docs" description: "Expert agent for creating and maintaining OpenAPI/Swagger documentation" type: "documentation" version: "1.0.0" runs entirely locally. Works with Claude Code, Cursor, Cline and 23 more.”.
- **02** When the source has headings, the agent prioritizes “Key responsibilities: / Best practices: / OpenAPI structure:” so the result follows the author’s structure.
- **03** Typical output includes task judgment, concrete steps, required commands or file edits, validation, and follow-up options.
- **04** Risk context follows the fingerprint: read files, write/modify files, run shell commands; mostly runs locally; usually needs no extra API key.
## Running Rules
- read files, write/modify files, run shell commands; mostly runs locally; usually needs no extra API key.
- Validate with a small sample before expanding scope.
- Return the result, validation criteria, and next iteration options. The source does not require a stable slash command. After installation, invoke the skill by name and describe the task.
Name target files or source material, expected output, forbidden changes, and whether network or shell access is allowed. Permission fingerprint: read files, write/modify files, run shell commands.
Start with a small task and check whether the result follows “Key responsibilities: / Best practices: / OpenAPI structure:”. Inspect diffs, logs, previews, or tests before expanding scope.
Confirm the final output includes a concrete result, evidence, and next action. If it stays generic, tighten inputs, boundaries, and acceptance criteria.
---
name: agent-docs-api-openapi
description: Agent skill for docs-api-openapi - invoke with $agent-docs-api-openapi name: "api-docs" descript…
category: documentation
source: ruvnet/ruflo
---
# agent-docs-api-openapi
## When to use
- Agent skill for docs-api-openapi - invoke with $agent-docs-api-openapi name: "api-docs" description: "Expert agent for…
- Use it when the task has clear inputs, repeatable steps, and validation criteria.
## What to provide
- Target material, scope, expected result, and forbidden changes.
- Whether network, commands, file writes, or external services are allowed.
## Execution rules
- Organize steps around “Key responsibilities: / Best practices: / OpenAPI structure:” and keep inference separate from source facts.
- read files, write/modify files, run shell commands; mostly runs locally; usually needs no extra API key.
- Validate with a small sample before expanding the task.
## Output requirements
- Return the deliverable, key evidence, validation method, and next action.
- Mark missing information as unknown; do not invent commands, platforms, or dependencies. The author source anchors workflow facts; repository files anchor sources and commands; Fluxly only adds fit, limitations, and quality judgment.
skill "agent-docs-api-openapi" {
input -> user goal + target files + boundaries + acceptance criteria
context -> Key responsibilities: / Best practices: / OpenAPI structure:
rules -> SKILL.md triggers / order / output contract
runtime -> no special runtime | read files, write/modify files, run shell commands | mostly runs locally
guardrails -> usually needs no extra API key + small-sample validation + diff/log review
output -> copyable result + checklist + next iteration
} 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
Decide Fit First
Design Intent
How To Use It
Boundaries And Review