Skip to content

Projects API

Project endpoints 用于管理 marketplace integrations:metadata、visibility/access level、links,以及 uploaded icon/cover images。

GET /api/v2/projects

返回当前 account 可访问的 projects 列表。

Arguments:

ArgumentLocationDescription
workspaceQueryOptional workspace fullname filter.
scopeQueryOptional scope: all, marketplace, backend.

Payload: 无。

响应:ProjectView[]

GET /api/v2/projects/create-capability

检查当前 account/workspace 是否可以创建 project。

Arguments: 无。

Payload: 无。

响应:ProjectCreateCapability

GET /api/v2/projects/:fullname

按 fullname 返回 project。

Arguments:

ArgumentLocationDescription
fullnamePathProject fullname.

Payload: 无。

响应:ProjectView

PUT /api/v2/projects/:fullname

创建或更新 project。

Arguments:

ArgumentLocationDescription
fullnamePathProject fullname. 必须与 payload.fullname 一致。

Payload:

FieldRequiredDescription
nameworkspace 内的 Project name。
fullname<workspace>.<name> 格式的 fullname。
workspaceWorkspace fullname.
publicLegacy public flag。新代码最好同时传入 accessLevel
visibilityStorage visibility: public, private_link, personal.
accessLevelProduct access level: private, public, free.
tagsProject tags.
labelsProject labels.
meta.titleproject 的可见名称。
meta.description完整描述。
meta.shortDescription短描述。
meta.links{ title, url } useful links 数组。
meta.iconIcon URL。可以是 uploaded asset URL。
meta.avatarAvatar URL。通常与 icon 相同。
meta.coverCover URL。可以是 uploaded asset URL。

响应:ProjectView

DELETE /api/v2/projects/:fullname

删除 project。

Arguments:

ArgumentLocationDescription
fullnamePathProject fullname.

Payload: 无。

响应:OperationResult

通过 access link 打开 private project。

Arguments:

ArgumentLocationDescription
tokenPathAccess link token.

Payload: 无。

响应:ProjectView

POST /api/v2/projects/:fullname/access-links

为 private project 创建 access link。

Arguments:

ArgumentLocationDescription
fullnamePathProject fullname.

Payload:

FieldRequiredDescription
maxUsagesMaximum link usages.
expiresAtExpiration date-time.

响应:ProjectAccessLink

POST /api/v2/projects/:fullname/assets/images

iconcover 上传 project image。

Arguments:

ArgumentLocationDescription
fullnamePathProject fullname.

Payload:

FieldRequiredDescription
filenameOriginal filename.
contentType图片 MIME type。
dataBase64 image data.
targeticoncover

响应:ProjectImageUploadResult。 保存 project 时,这个 URL 会传入 meta.iconmeta.cover

DELETE /api/v2/projects/:fullname/images/:asset

删除 uploaded project image。

Arguments:

ArgumentLocationDescription
fullnamePathProject fullname.
assetPathAsset filename,例如 icon.png 或 draft asset name。

Payload: 无。

响应:OperationResult