mirror of
https://gitee.com/mateos/mateclaw.git
synced 2026-09-13 03:13:41 +08:00
docs(api): align workflow & trigger endpoint reference with actual controllers (#248)
This commit is contained in:
matevip
parent
bb2cf12f49
commit
18f3675fd3
@ -437,20 +437,24 @@ Full field reference, step modes, and Pebble syntax in [Workflow](./workflow).
|
||||
GET /api/v1/workflows # List
|
||||
GET /api/v1/workflows/{id} # Fetch (published revision + draft)
|
||||
POST /api/v1/workflows # Create
|
||||
PUT /api/v1/workflows/{id}/draft # Save draft (graph_json)
|
||||
PUT /api/v1/workflows/{id} # Update metadata (name / description / enabled)
|
||||
PUT /api/v1/workflows/{id}/draft # Save draft (graph_json, no compile)
|
||||
POST /api/v1/workflows/{id}/publish # Publish draft as a new revision
|
||||
DELETE /api/v1/workflows/{id} # Delete
|
||||
|
||||
POST /api/v1/workflows/{id}/compile # Compile saved draft + diagnostics, no publish
|
||||
POST /api/v1/workflows/draft/generate # Natural-language → graph_json draft
|
||||
POST /api/v1/workflows/{id}/preview-compile # Static checks + Pebble validation, no publish
|
||||
POST /api/v1/workflows/draft/preview-compile # Compile arbitrary draft JSON (no persist; template/generator preview)
|
||||
GET /api/v1/workflows/draft/templates # Templates the generator can apply directly
|
||||
|
||||
POST /api/v1/workflows/{id}/runs # Start a run (async)
|
||||
GET /api/v1/workflows/{id}/runs # Run list
|
||||
GET /api/v1/workflows/{id}/runs # Run list (limit, default 50)
|
||||
GET /api/v1/workflows/runs/paused # All paused runs in the workspace (operator entry)
|
||||
GET /api/v1/workflows/runs/{runId} # Run detail + per-step input/output/tokens/duration
|
||||
POST /api/v1/workflows/runs/{runId}/resume # Resume after await_approval
|
||||
POST /api/v1/workflows/runs/{runId}/cancel # Cancel in-flight
|
||||
```
|
||||
|
||||
> v0 has no manual "start run / cancel run" endpoint — a workflow actually starts only via a [Trigger](./triggers) or an `await_approval` resume (`/runs/{runId}/resume`). For a dry run use `/draft/preview-compile` (compile only, no persist, no execution). A manual run endpoint is planned for a later release.
|
||||
|
||||
---
|
||||
|
||||
## Triggers (1.3.0+)
|
||||
@ -461,13 +465,11 @@ Six pattern types, event governance, cross-instance consistency in [Triggers](./
|
||||
GET /api/v1/triggers # List
|
||||
GET /api/v1/triggers/{id} # Fetch
|
||||
POST /api/v1/triggers # Create
|
||||
PUT /api/v1/triggers/{id} # Update
|
||||
PUT /api/v1/triggers/{id} # Update (includes enabled toggle; changing the cron expr bumps pattern_version)
|
||||
DELETE /api/v1/triggers/{id} # Delete
|
||||
PUT /api/v1/triggers/{id}/toggle?enabled={bool} # Toggle
|
||||
|
||||
POST /api/v1/triggers/events # Generic event ingress (webhook / external bridge)
|
||||
# ACKs 200 immediately, dispatches asynchronously
|
||||
GET /api/v1/triggers/{id}/events # Event history for this trigger
|
||||
POST /api/v1/triggers/events # Generic event ingress (webhook / external bridge); scoped by X-Workspace-Id
|
||||
# → dedup / rate-limit / bot-self, then dispatches synchronously and returns each trigger's fire/drop result
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
@ -437,20 +437,24 @@ POST /api/v1/cron-jobs/{id}/run # 立即执行
|
||||
GET /api/v1/workflows # 列表
|
||||
GET /api/v1/workflows/{id} # 获取（含已发布 revision + 草稿）
|
||||
POST /api/v1/workflows # 新建
|
||||
PUT /api/v1/workflows/{id}/draft # 保存草稿（graph_json）
|
||||
PUT /api/v1/workflows/{id} # 更新元数据（name / description / enabled）
|
||||
PUT /api/v1/workflows/{id}/draft # 保存草稿（graph_json，不编译）
|
||||
POST /api/v1/workflows/{id}/publish # 发布草稿为新 revision
|
||||
DELETE /api/v1/workflows/{id} # 删除
|
||||
|
||||
POST /api/v1/workflows/{id}/compile # 编译已存草稿 + 诊断，不发布
|
||||
POST /api/v1/workflows/draft/generate # 自然语言生成 graph_json 草稿
|
||||
POST /api/v1/workflows/{id}/preview-compile # 静态检查 + Pebble 校验，不发布
|
||||
POST /api/v1/workflows/draft/preview-compile # 编译任意草稿 JSON（不入库，模板/生成器预览）
|
||||
GET /api/v1/workflows/draft/templates # 生成器可直接套用的模板列表
|
||||
|
||||
POST /api/v1/workflows/{id}/runs # 起一个 run（异步）
|
||||
GET /api/v1/workflows/{id}/runs # run 列表
|
||||
GET /api/v1/workflows/{id}/runs # run 列表（limit，默认 50）
|
||||
GET /api/v1/workflows/runs/paused # 当前 workspace 所有 paused run（运维入口）
|
||||
GET /api/v1/workflows/runs/{runId} # run 详情 + 每步 input/output/token/duration
|
||||
POST /api/v1/workflows/runs/{runId}/resume # await_approval 后恢复
|
||||
POST /api/v1/workflows/runs/{runId}/cancel # 取消运行中
|
||||
POST /api/v1/workflows/runs/{runId}/resume # await_approval 暂停后恢复
|
||||
```
|
||||
|
||||
> v0 没有「手动起 run / 取消 run」的端点——工作流的实际启动只能经[触发器](./triggers)或 `await_approval` 恢复（`/runs/{runId}/resume`）；想试跑用 `/draft/preview-compile`（只编译、不入库、不真跑）。手动启动 run 已在规划中，后续版本提供。
|
||||
|
||||
---
|
||||
|
||||
## 触发器（1.3.0+）
|
||||
@ -461,13 +465,11 @@ POST /api/v1/workflows/runs/{runId}/cancel # 取消运行中
|
||||
GET /api/v1/triggers # 列表
|
||||
GET /api/v1/triggers/{id} # 获取
|
||||
POST /api/v1/triggers # 新建
|
||||
PUT /api/v1/triggers/{id} # 更新
|
||||
PUT /api/v1/triggers/{id} # 更新（含 enabled 开关；改 cron 表达式会 bump pattern_version）
|
||||
DELETE /api/v1/triggers/{id} # 删除
|
||||
PUT /api/v1/triggers/{id}/toggle?enabled={bool} # 开关
|
||||
|
||||
POST /api/v1/triggers/events # 通用事件入口（webhook / 桥接外部系统）
|
||||
# 立即 ACK 200，异步派发
|
||||
GET /api/v1/triggers/{id}/events # 该 trigger 的事件历史
|
||||
POST /api/v1/triggers/events # 通用事件入口（webhook / 桥接外部系统）；按 X-Workspace-Id 投递
|
||||
# → 经去重 / 限流 / bot-self 后同步派发，返回每条 trigger 的 fire/drop 结果
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
Loading…
Reference in New Issue
Block a user