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/v2/apps

返回 apps。

参数:

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

Payload: 无。

响应:AppView[]

GET /api/v2/apps/:fullname

返回 app。

参数:fullname path argument。

Payload: 无。

响应:AppView

PUT /api/v2/apps/:fullname

创建或更新 app。

Payload:

字段必填说明
nameApp name。
fullnameApp fullname。
projectProject fullname。
workspaceWorkspace fullname。
urlApp URL。
tagsTags。
labelsLabels。

响应:AppView

DELETE /api/v2/apps/:fullname

删除 app。

参数:fullname path argument。

Payload: 无。

响应:OperationResult

Actions

GET /api/v2/actions

返回 actions。

参数:

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

Payload: 无。

响应:ActionView[]

GET /api/v2/actions/:fullname

返回 action。

参数:fullname path argument。

Payload: 无。

响应:ActionView

PUT /api/v2/actions/:fullname

创建或更新 action。

Payload:

字段必填说明
nameAction name。
fullnameAction fullname。
projectProject fullname。
workspaceWorkspace fullname。
backendAction backend definition。
valuesAction values schema。
overridesAction 可以覆盖的字段。
tagsTags。
labelsLabels。
metaAction metadata。

响应:ActionView

DELETE /api/v2/actions/:fullname

删除 action。

参数:fullname path argument。

Payload: 无。

响应:OperationResult

Blueprints

GET /api/v2/blueprints

返回 blueprints。

参数:

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

Payload: 无。

响应:BlueprintView[]

GET /api/v2/blueprints/:fullname

返回 blueprint。

参数:fullname path argument。

Payload: 无。

响应:BlueprintView

PUT /api/v2/blueprints/:fullname

创建或更新 blueprint。

Payload:

字段必填说明
nameBlueprint name。
fullnameBlueprint fullname。
appApp fullname。
projectProject fullname。
workspaceWorkspace fullname。
typeplainexternal
dataObject spec。
tagsTags。
labelsLabels。
meta.title可见标题。
meta.description描述。

响应:BlueprintView

DELETE /api/v2/blueprints/:fullname

删除 blueprint。

参数:fullname path argument。

Payload: 无。

响应:OperationResult

Types

GET /api/v2/types

返回 shared types。

参数:

参数位置说明
projectQuery可选 project 过滤器。
workspaceQuery可选 workspace 过滤器。
statusQuerynot_testedreadybroken
palletQuery可选 pallet 过滤器。
kindQueryeventcalltransactiontimer
dataSourceQuery可选 data source 过滤器。

Payload: 无。

响应:SharedTypeView[]

GET /api/v2/types/:fullname

返回 shared type。

参数:fullname path argument。

Payload: 无。

响应:SharedTypeView

PUT /api/v2/types/:fullname

创建或更新 shared type。

Payload:

字段必填说明
nameShared type collection name。
fullnameShared type fullname。
projectProject fullname。
workspaceWorkspace fullname。
schemas包含 named type schemas 的对象。
tagsTags。
labelsLabels。
metaMetadata object。

响应:SharedTypeView

DELETE /api/v2/types/:fullname

删除 shared type。

参数:fullname path argument。

Payload: 无。

响应:OperationResult