Skip to content

Apps, Actions, Blueprints 和 Types API ​

这些 endpoints 描述 builder/registry layer: apps、actions、blueprints 和 shared types。它们用于 service integrations 以及可复用的 resource/action definitions。

Apps ​

GET /api/apps ​

返回 apps。

参数:

参数位置说明
projectQuery可选 project fullname 过滤器。
workspaceQuery可选 workspace fullname 过滤器。

Payload: 无。

响应:AppView[]。

GET /api/apps/:fullname ​

返回 app。

参数:fullname path argument。

Payload: 无。

响应:AppView。

PUT /api/apps/:fullname ​

创建或更新 app。

Payload:

字段必填说明
name是App name。
fullname是App fullname。
project是Project fullname。
workspace是Workspace fullname。
url是App URL。
tags否Tags。
labels否Labels。

响应:AppView。

DELETE /api/apps/:fullname ​

删除 app。

参数:fullname path argument。

Payload: 无。

响应:OperationResult。

Actions ​

GET /api/actions ​

返回 actions。

参数:

参数位置说明
projectQuery可选 project 过滤器。
workspaceQuery可选 workspace 过滤器。

Payload: 无。

响应:ActionView[]。

GET /api/actions/:fullname ​

返回 action。

参数:fullname path argument。

Payload: 无。

响应:ActionView。

PUT /api/actions/:fullname ​

创建或更新 action。

Payload:

字段必填说明
name是Action name。
fullname是Action fullname。
project是Project fullname。
workspace是Workspace fullname。
backend是Action backend definition。
values是Action values schema。
overrides是Action 可以覆盖的字段。
tags否Tags。
labels否Labels。
meta是Action metadata。

响应:ActionView。

DELETE /api/actions/:fullname ​

删除 action。

参数:fullname path argument。

Payload: 无。

响应:OperationResult。

Blueprints ​

GET /api/blueprints ​

返回 blueprints。

参数:

参数位置说明
appQuery可选 app fullname 过滤器。
projectQuery可选 project fullname 过滤器。
workspaceQuery可选 workspace fullname 过滤器。

Payload: 无。

响应:BlueprintView[]。

GET /api/blueprints/:fullname ​

返回 blueprint。

参数:fullname path argument。

Payload: 无。

响应:BlueprintView。

PUT /api/blueprints/:fullname ​

创建或更新 blueprint。

Payload:

字段必填说明
name是Blueprint name。
fullname是Blueprint fullname。
app是App fullname。
project是Project fullname。
workspace是Workspace fullname。
type是plain 或 external。
data否Object spec。
tags否Tags。
labels否Labels。
meta.title否可见标题。
meta.description否描述。

响应:BlueprintView。

DELETE /api/blueprints/:fullname ​

删除 blueprint。

参数:fullname path argument。

Payload: 无。

响应:OperationResult。

Types ​

GET /api/types ​

返回 shared types。

参数:

参数位置说明
projectQuery可选 project 过滤器。
workspaceQuery可选 workspace 过滤器。
statusQuerynot_tested、ready 或 broken。
palletQuery可选 pallet 过滤器。
kindQueryevent、call、transaction 或 timer。
dataSourceQuery可选 data source 过滤器。

Payload: 无。

响应:SharedTypeView[]。

GET /api/types/lookup ​

解析 trigger 关联目录中的动态类型选项。

参数:

参数位置说明
triggerQueryTrigger fullname。
refQuery要解析的 type schema 引用。
qQuery可选文本搜索。
valueQuery可选精确值。
limitQuery可选结果数量限制。
其他字段Query可选依赖值,例如 series 或 event。

Payload: 无。

响应包含 ref、带 label、value 和可选 parents 的规范化 items,以及可选的 nextCursor。

GET /api/types/:fullname ​

返回 shared type。

参数:fullname path argument。

Payload: 无。

响应:SharedTypeView。

PUT /api/types/:fullname ​

创建或更新 shared type。

Payload:

字段必填说明
name是Shared type collection name。
fullname是Shared type fullname。
project是Project fullname。
workspace是Workspace fullname。
schemas是包含 named type schemas 的对象。
tags否Tags。
labels否Labels。
meta否Metadata object。

响应:SharedTypeView。

DELETE /api/types/:fullname ​

删除 shared type。

参数:fullname path argument。

Payload: 无。

响应:OperationResult。