{
  "instruction": "Provide API documentation for endpoint consumers",
  "relevant_when": "Agent builds a REST API with multiple endpoints",
  "context": "API consumers need to know endpoints, request/response shapes, and error formats without reading source code.",
  "sources": [
    {
      "type": "file",
      "filename": "skills/api-documentation/SKILL.md",
      "tile": "tessl-labs/api-documentation@0.1.3"
    }
  ],
  "checklist": [
    {
      "name": "every-endpoint-documented",
      "rule": "Every API endpoint has documentation covering method, path, and a one-line summary",
      "relevant_when": "Agent builds or modifies a multi-endpoint API"
    },
    {
      "name": "request-body-documented",
      "rule": "Request body shapes are documented with field names, types, and required/optional markers for all POST/PUT/PATCH endpoints",
      "relevant_when": "API has endpoints accepting request bodies"
    },
    {
      "name": "response-shapes-documented",
      "rule": "Success response shapes are documented with status codes for all endpoints",
      "relevant_when": "Agent builds or modifies a multi-endpoint API"
    },
    {
      "name": "error-responses-documented",
      "rule": "Error responses (4xx/5xx) are documented with status codes and descriptions for endpoints that can fail",
      "relevant_when": "Agent builds or modifies a multi-endpoint API"
    },
    {
      "name": "interactive-docs-or-markdown",
      "rule": "Agent provides interactive docs (Swagger UI, ReDoc) when using a framework that supports it, or a markdown docs file otherwise",
      "relevant_when": "Agent builds a multi-endpoint API"
    },
    {
      "name": "task-deliverables-complete",
      "rule": "All task-specified output files, scripts, and deliverables are produced exactly as requested",
      "relevant_when": "Task specifies particular output files or scripts"
    }
  ]
}