dreampiler/kandev
1
0
Fork 0
Code Issues 43 Pull Requests Actions 6 Packages Projects Releases Wiki Activity

Add OpenAPI 3.0 specification for complete API documentation

Browse Source 
- docs/openapi.yaml: Full OpenAPI 3.0 spec (1174 lines)
  - All endpoints for Health, Boards, Columns, Tasks APIs
  - Agent lifecycle APIs (launch, stop, status, logs, types)
  - Orchestrator APIs (queue, trigger, task control)
  - Complete request/response schemas
  - Parameter definitions and error responses

- Updated AGENTS.md to reference OpenAPI spec

Compatible with Swagger UI, Redoc, and Postman.
This commit is contained in:
jcfs
2026-01-10 10:23:34 +00:00
parent 56c73914f8
commit c36a5d28c0
2 changed files with 1181 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+7 -2
View File
@@ -1,7 +1,12 @@
# Kandev Agents Guide
> ⚠️ **IMPORTANT**: API documentation in this file must be updated whenever the API changes.
> When modifying any endpoint, request/response types, or ACP messages, update this document accordingly.
> ⚠️ **IMPORTANT**: API documentation must be updated whenever the API changes.
> When modifying any endpoint, request/response types, or ACP messages, update:
> - This document (AGENTS.md)
> - The OpenAPI spec (docs/openapi.yaml)
📖 **Full API Reference**: See [docs/openapi.yaml](docs/openapi.yaml) for the complete OpenAPI 3.0 specification.
You can view it with Swagger UI, Redoc, or import it into Postman.
## Overview