Menu
API documentation standards using OpenAPI/Swagger, including endpoints, authentication, examples, and error handling
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
GitHub Agentic Workflows (gh-aw) - markdown-based AI automation with 5-layer security, safe outputs, and Continuous AI patterns
gh-aw CLI usage, compilation, testing, debugging, add-wizard, and CI/CD practices for GitHub Agentic Workflows
Multi-agent coordination, orchestrator-worker patterns, /plan decomposition, and project coordination for GitHub Agentic Workflows
5-layer defense-in-depth security for GitHub Agentic Workflows - safe outputs, threat detection, AWF firewall, and zero-trust patterns
Continuous AI patterns from Agent Factory - issue triage, documentation sync, code quality, security scanning, and project coordination
GDPR compliance including privacy by design, data protection requirements, consent management, right to be forgotten, and data breach response
| name | api-documentation |
| description | API documentation standards using OpenAPI/Swagger, including endpoints, authentication, examples, and error handling |
| license | Apache-2.0 |
Provides comprehensive API documentation that enables developers to quickly understand and integrate with APIs through clear examples, authentication guidance, and error handling.
MUST USE OpenAPI 3.0+:
openapi: 3.0.0
info:
title: Hack23 API
version: 1.0.0
description: Cybersecurity services API
contact:
email: api@hack23.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://api.hack23.com/v1
description: Production
- url: https://staging-api.hack23.com/v1
description: Staging
paths:
/users:
get:
summary: List users
operationId: listUsers
tags: [Users]
security:
- bearerAuth: []
parameters:
- name: limit
in: query
schema:
type: integer
default: 20
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
'401':
$ref: '#/components/responses/Unauthorized'
components:
schemas:
User:
type: object
required: [id, email]
properties:
id:
type: string
format: uuid
email:
type: string
format: email
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
MUST INCLUDE:
1. Overview & Getting Started
- What the API does
- Base URL
- Authentication
- Rate limits
- Quick start example
2. Authentication
- How to obtain credentials
- How to authenticate requests
- Token refresh process
- Security best practices
3. Endpoints
- HTTP method and path
- Description
- Request parameters
- Request body schema
- Response schema
- Error responses
- Code examples
4. Error Handling
- Error code list
- Error response format
- Common errors
- Troubleshooting
5. SDKs & Libraries
- Official SDK links
- Community libraries
- Code samples
6. Changelog
- Version history
- Breaking changes
- Migration guides
MUST PROVIDE examples in:
Example:
## Create User
`POST /users`
Creates a new user account.
### Request Body
```json
{
"email": "user@example.com",
"name": "John Doe"
}
curl -X POST https://api.hack23.com/v1/users \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"email":"user@example.com","name":"John Doe"}'
const response = await fetch('https://api.hack23.com/v1/users', {
method: 'POST',
headers: {
'Authorization': `Bearer ${token}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
email: 'user@example.com',
name: 'John Doe'
})
});
const user = await response.json();
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"email": "user@example.com",
"name": "John Doe",
"createdAt": "2026-02-06T10:00:00Z"
}
### Error Documentation
**Standard Error Format:**
```json
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid email format",
"details": [
{
"field": "email",
"message": "Must be a valid email address"
}
],
"requestId": "req_123456",
"timestamp": "2026-02-06T10:00:00Z"
}
}