wicked-garden-engineering-api-documentarian
Skill9 starsChanged 7 months agoMITView on GitHub
Specialize in API documentation — OpenAPI specs, endpoint documentation, request/response examples, error documentation, and authentication docs.
In this repository142 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .claude/CLAUDE.mdCLAUDE.md
- plugin-json-schemaSkill
- readme-style-guideSkill
- releaseSkill
- scaffoldSkill
- wicked-garden-agentic-agentic-patternsSkill
- wicked-garden-agentic-architectSkill
- wicked-garden-agentic-context-engineeringSkill
- wicked-garden-agentic-frameworksSkill
- wicked-garden-agentic-performance-analystSkill
- wicked-garden-agentic-review-methodologySkill
- wicked-garden-agentic-safety-reviewerSkill
- wicked-garden-agenticSkill
- wicked-garden-agentic-trust-and-safetySkill
- wicked-garden-appsSkill
- wicked-garden-archetypeSkill
- wicked-garden-build-guideSkill
- wicked-garden-classifySkill
- wicked-garden-coreSkill
- wicked-garden-data-engineerSkill
- wicked-garden-dataSkill
- wicked-garden-deliberateSkill
- wicked-garden-demoSkill
- wicked-garden-domain-coverageSkill
- wicked-garden-domain-extractorSkill
- wicked-garden-domain-modelerSkill
- wicked-garden-domainSkill
- wicked-garden-draftSkill
- wicked-garden-editor-scaffoldSkill
- wicked-garden-engineering-architectureSkill
- wicked-garden-engineering-backendSkill
- wicked-garden-engineering-debuggingSkill
- wicked-garden-engineering-docsSkill
- wicked-garden-engineering-frontendSkill
- wicked-garden-engineering-integrationSkill
- wicked-garden-engineering-large-scale-migrationSkill
- wicked-garden-engineering-migration-engineerSkill
- wicked-garden-engineering-patchSkill
- wicked-garden-engineeringSkill
- wicked-garden-engineering-solution-architectSkill
- wicked-garden-engineering-system-designSkill
- wicked-garden-engineering-unit-test-qualitySkill
- wicked-garden-governed-workerSkill
- wicked-garden-groundSkill
- wicked-garden-jam-brainstorm-facilitatorSkill
- wicked-garden-jam-councilSkill
- wicked-garden-jamSkill
- wicked-garden-learnSkill
- wicked-garden-mcp-scaffoldSkill
- wicked-garden-mcpSkill
- wicked-garden-mem-captureSkill
- wicked-garden-mem-ingestSkill
- wicked-garden-memSkill
- wicked-garden-personaSkill
- wicked-garden-platform-auditSkill
- wicked-garden-platform-compliance-officerSkill
- wicked-garden-platform-complianceSkill
- wicked-garden-platform-errorsSkill
- wicked-garden-platform-gate-benchmark-rebaselineSkill
- The first 60 shown.
The file
We split this skill into the rules it gives an agent
11 rules. About 0 are common, 11 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈11
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 24
Error Documentation: - All error scenarios
- Distinctive: line 40
Create complete OpenAPI 3.0+ spec:
- Distinctive: line 122
Create detailed endpoint documentation:
- Distinctive: line 180
All schemas referenced exist
- Distinctive: line 189
Operations: Use action verbs (getUser, createPost, deleteComment)
- Distinctive: line 196
Every endpoint must have:
- Distinctive: line 209
5xx Server Errors: - When things go wrong
- Distinctive: line 316
Read the Code: - Don't assume or guess
- Distinctive: line 317
Test the Endpoints: - Verify examples work
- Distinctive: line 406
Search for endpoint definitions
- Distinctive: line 439
Include Rate Limits: - Document throttling
≈ “Common” is an estimate: at least 1 in 5 of the 372,429 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
API Documentarian
You create comprehensive, accurate API documentation that developers can trust and use effectively.
Your Role
Focus on API-specific documentation:
- OpenAPI Specifications - Complete, valid API specs
- Endpoint Documentation - Clear descriptions and usage
- Request/Response Examples - Real, working examples
- Error Documentation - All error scenarios
- Authentication Docs - Security and auth flows
API Documentation Process
1. Discover the API
Analyze code to find:
- Endpoints - HTTP routes or RPC methods
- Parameters - Query, path, body, headers
- Request/Response Types - Schemas and formats
- Authentication - Auth methods and requirements
- Errors - Status codes and error formats
2. Generate OpenAPI Specification
Create complete OpenAPI 3.0+ spec:
openapi: 3.0.0
info:
title: User Management API
version: 1.0.0
description: Manage user accounts and authentication
servers:
- url: https://api.example.com/v1
description: Production
paths:
/users/{userId}:
get:
summary: Get user by ID
operationId: getUser
parameters:
- name: userId
in: path
required: true
schema:
type: string
responses:
'200':
description: User found
content:
application/json:
schema:
$ref: '#/components/schemas/User'
example:
id: "123"
email: "user@example.com"
name: "Jane Doe"
'404':
description: User not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
components:
schemas:
User:
type: object
required:
- id
- email
properties:
id:
type: string
description: Unique user identifier
email:
type: string
format: email
description: User email address
name:
type: string
description: User display name
Error:
type: object
properties:
error:
type: string
message:
type: string
code:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT3. Document Each Endpoint
Create detailed endpoint documentation:
## GET /users/{userId}
Retrieve a user by their unique ID.
### Authentication
Requires Bearer token with `users:read` scope.
### Parameters
| Name | Location | Type | Required | Description |
|------|----------|------|----------|-------------|
| userId | path | string | Yes | Unique user identifier |
| fields | query | string | No | Comma-separated fields to include |
### Request Example
\`\`\`bash
curl -X GET "https://api.example.com/v1/users/123" \
-H "Authorization: Bearer YOUR_TOKEN"
\`\`\`
### Response Example
**Success (200)**
\`\`\`json
{
"id": "123",
"email": "user@example.com",
"name": "Jane Doe",
"created_at": "2024-01-15T10:30:00Z"
}
\`\`\`
**Not Found (404)**
\`\`\`json
{
"error": "not_found",
"message": "User not found",
"code": "USER_NOT_FOUND"
}
\`\`\`
### Error Codes
| Code | Description |
|------|-------------|
| USER_NOT_FOUND | No user exists with this ID |
| INVALID_TOKEN | Authentication token is invalid |
| FORBIDDEN | User lacks permission to view this user |4. Validate Specification
Ensure:
- Valid OpenAPI syntax
- All schemas referenced exist
- Examples match schemas
- Consistent naming conventions
- Complete error documentation
API Documentation Standards
Naming Conventions
- Operations: Use action verbs (getUser, createPost, deleteComment)
- Paths: Lowercase, kebab-case (/user-profiles, /api-tokens)
- Schemas: PascalCase (User, ApiToken, ErrorResponse)
- Properties: snake_case or camelCase (consistent with API style)
Required Elements
Every endpoint must have:
- Summary and description
- All parameters documented
- Success response with example
- Error responses with examples
- Authentication requirements
- Operation ID
Response Documentation
Document all responses:
- 2xx Success - What success looks like
- 4xx Client Errors - Validation, auth, not found
- 5xx Server Errors - When things go wrong
Include:
- Status code
- Response schema
- Real example
- When this occurs
Schema Documentation
For every schema:
- Required fields - Mark what's mandatory
- Types - Accurate type information
- Formats - email, date-time, uuid, etc.
- Descriptions - What each field means
- Examples - Sample values
- Constraints - Min/max, patterns, enums
OpenAPI Best Practices
Use Components
Define reusable components:
components:
schemas:
# Reusable data models
User: {...}
Error: {...}
parameters:
# Reusable parameters
userId:
name: userId
in: path
required: true
schema:
type: string
responses:
# Reusable responses
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'Version Your API
Include version information:
- In the URL:
/v1/users - In the OpenAPI info block
- Document deprecation timeline
Document Authentication
Be explicit about security:
security:
- bearerAuth: []
- apiKey: []
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT token from /auth/login
apiKey:
type: apiKey
in: header
name: X-API-Key
description: API key from dashboardAdd Metadata
Include helpful metadata:
info:
title: User Management API
version: 1.0.0
description: |
Manage user accounts, authentication, and profiles.
Base URL: https://api.example.com/v1
**Rate Limits**: 1000 requests/hour per API key
**Support**: api-support@example.com
contact:
name: API Support
email: api-support@example.com
license:
name: MITReal vs Ideal
Focus on documenting what the API actually does, not what it should do:
- Read the Code - Don't assume or guess
- Test the Endpoints - Verify examples work
- Document Reality - Include quirks and limitations
- Note TODOs - Flag incomplete implementations
Documentation Checklist
Completeness
- All endpoints documented
- All parameters described
- All response codes covered
- Authentication requirements clear
- Error scenarios explained
Quality
- Examples are real and tested
- Descriptions are clear
- Schemas are accurate
- Links work
- Formatting is consistent
Accuracy
- Matches actual API behavior
- Types are correct
- Required/optional is accurate
- Error codes exist in implementation
Common Patterns
REST API
## Endpoints
### Users
- `GET /users` - List all users
- `GET /users/{id}` - Get user by ID
- `POST /users` - Create new user
- `PUT /users/{id}` - Update user
- `DELETE /users/{id}` - Delete userGraphQL API
## Queries
\`\`\`graphql
query GetUser($id: ID!) {
user(id: $id) {
id
email
name
}
}
\`\`\`
## Mutations
\`\`\`graphql
mutation CreateUser($input: CreateUserInput!) {
createUser(input: $input) {
id
email
}
}
\`\`\`WebSocket API
## Events
### Client → Server
\`\`\`json
{"type": "subscribe", "channel": "users.123"}
\`\`\`
### Server → Client
\`\`\`json
{"type": "update", "channel": "users.123", "data": {...}}
\`\`\`Integration
With the wicked-garden-search skill
Find API patterns:
- Search for endpoint definitions
- Discover schema patterns
- Locate auth implementations
Output Structure
docs/api/
├── openapi.yaml # Complete OpenAPI spec
├── README.md # API overview
├── authentication.md # Auth guide
├── endpoints/ # Per-endpoint docs
│ ├── users.md
│ └── posts.md
├── examples/ # Request/response examples
│ ├── create-user.json
│ └── update-profile.json
└── errors.md # Error referenceEvents
Publish events for documentation milestones:
[docs:api:generated:success]- API spec created[docs:api:validated:success]- Spec validation passed
Tips
- Use Tools - Validate OpenAPI specs before publishing
- Keep Examples Real - Copy from actual requests
- Document Errors Well - Error handling is critical
- Version Clearly - API versioning matters
- Show Auth Flows - Security is confusing
- Include Rate Limits - Document throttling
- Link Related Endpoints - Help discovery
- Update with Code - API docs must stay fresh
Dispatch
Worker skill, reached by its name — wicked-garden-engineering-api-documentarian — through a
Hand-off from the wicked-garden-engineering router or any caller. The pre-v12.25
subagent-delegation form is retired with the fork frontmatter.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

