跳到主要内容

SummaryListResponse

errCodeintegerrequired
Constant value: 0
errMessagestringrequired
Constant value:
data objectrequired
items object[]required
  • Array [
  • idstringrequired

    项目 UUID,同时也是 server 权限与上传校验边界。

    namestringrequired
    projectTypeProjectKindrequired

    所有项目类型均由静态 package.json.steamHarness.projectType 声明。Server 只读取静态元数据,不加载项目代码。

    Possible values: [workflow, conversation, kanban]

    projectCard objectrequired
    iconstringrequired

    Possible values: [workflow, message-circle, bot, sparkles, code, git-branch, boxes, zap, database, file-text, cpu, brain]

    iconUrlstring<uri>

    Optional legacy image URL retained for backward compatibility. Server Web and Studio render project avatars from icon, iconColor, and iconBackgroundColor instead.

    iconColorstring

    Optional built-in icon foreground color. Defaults to white for older metadata.

    Possible values: Value must match regular expression ^#[0-9a-fA-F]{6}$

    iconBackgroundColorstringrequired

    Possible values: Value must match regular expression ^#[0-9a-fA-F]{6}$

    projectInfo objectrequired

    项目元数据权威模型。读取旧项目时 dataStorage 可能为 null,其它创建或保存请求必须使用 DeclaredProjectInfo 并提供有效 mode。当前界面识别 zh-CN、en、 multilingual、multiplatform、macos、windows 和 web;符合格式的未来 locale 或 ID 原样保留。

    Authoritative project metadata model. Legacy read responses may carry null dataStorage; create and save requests use DeclaredProjectInfo with an explicit valid mode.

    localizedNames objectrequired
    property name*string
    declarationsstring[]required

    Possible values: Value must match regular expression ^[a-z][a-z0-9-]*$

    platformSupport objectrequired
    oneOf
    modestringrequired
    Constant value: agnostic
    dataStorage objectrequired

    严格限定项目可访问的数据位置;null 只表示尚未迁移的旧项目。 / Strictly limits accessible data locations; null represents an undeclared legacy project only.

    oneOf
    modestringrequired

    local 仅本地,server 仅服务器,both 允许显式选择两端。 / local permits local storage only, server permits server storage only, and both permits an explicit choice.

    Possible values: [local, server, both]

    relatedProjects object[]required

    Possible values: <= 32

  • Array [
  • aliasstringrequired

    Possible values: Value must match regular expression ^[a-z][a-z0-9_-]{0,63}$

    projectIdstring<uuid>required
    grantToRelatedProject objectrequired

    允许关联项目访问当前项目 KV 的规则;不是当前项目访问对方的权限。

    read objectrequired
    oneOf
    modestringrequired
    Constant value: none
    write objectrequired
    oneOf
    modestringrequired
    Constant value: none
  • ]
  • ownerUserIdstring

    历史创建者字段,不用于授权。 / Historical creator; never an authorization source.

    visibilityVisibilityrequired

    Possible values: [private, public]

    createdByUserIdstring
    createdByProfile object
    userIdstringrequired
    displayNamestringrequired
    emailstring

    Optional email address for the profile summary.

    avatarUrlstring

    Optional avatar image URL or data URL for the uploader profile.

    createdAtstring<date-time>
    updatedAtstring<date-time>
    hasDraftbooleanrequired
    lateststring | nullnullablerequired

    最新不可变已发布源码版本。

    versionsstring[]required
    nextVersionstringrequired
    sourceDownload object
    allowedbooleanrequired

    当前身份是否具备下载项目源码的权限。

    availablebooleanrequired

    latest 版本是否保留原始源码。

    targetstring | nullnullablerequired
    groupIdstring | nullnullable
    access objectrequired
    effectiveRole objectrequired
    oneOf

    权限逐级累加:访客只读;开发者编辑草稿、上传、发布、写服务器数据;维护者管理设置和低级成员;所有者管理全部成员、删除与转移。 / Cumulative guest, developer, maintainer and owner roles.

    ProjectRole

    权限逐级累加:访客只读;开发者编辑草稿、上传、发布、写服务器数据;维护者管理设置和低级成员;所有者管理全部成员、删除与转移。 / Cumulative guest, developer, maintainer and owner roles.

    Possible values: [guest, developer, maintainer, owner]

    sources object[]required
  • Array [
  • typestringrequired

    Possible values: [project, group, public, system]

    idstringrequired
    namestring
    roleProjectRolerequired

    权限逐级累加:访客只读;开发者编辑草稿、上传、发布、写服务器数据;维护者管理设置和低级成员;所有者管理全部成员、删除与转移。 / Cumulative guest, developer, maintainer and owner roles.

    Possible values: [guest, developer, maintainer, owner]

  • ]
  • capabilitiesAccessCapability[]required

    Possible values: [read, downloadSource, readDraft, upload, publish, writeData, manageSettings, manageMembers, manageOwners, transfer, delete, createProject, createSubgroup]

  • ]
  • totalintegerrequired

    Possible values: >= 0

    pageintegerrequired

    Possible values: >= 1

    pageSizeintegerrequired

    Possible values: >= 1 and <= 100

    SummaryListResponse
    {
    "errCode": 0,
    "errMessage": "string",
    "data": {
    "items": [
    {
    "id": "string",
    "name": "string",
    "projectType": "workflow",
    "projectCard": {
    "icon": "workflow",
    "iconUrl": "string",
    "iconColor": "string",
    "iconBackgroundColor": "string"
    },
    "projectInfo": {
    "localizedNames": {},
    "declarations": [
    "string"
    ],
    "platformSupport": {
    "mode": "agnostic"
    },
    "dataStorage": {
    "mode": "local"
    },
    "relatedProjects": [
    {
    "alias": "string",
    "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "grantToRelatedProject": {
    "read": {
    "mode": "none"
    },
    "write": {
    "mode": "none"
    }
    }
    }
    ]
    },
    "ownerUserId": "string",
    "visibility": "private",
    "createdByUserId": "string",
    "createdByProfile": {
    "userId": "string",
    "displayName": "string",
    "email": "string",
    "avatarUrl": "string"
    },
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z",
    "hasDraft": true,
    "latest": "string",
    "versions": [
    "string"
    ],
    "nextVersion": "string",
    "sourceDownload": {
    "allowed": true,
    "available": true,
    "target": "string"
    },
    "groupId": "string",
    "access": {
    "effectiveRole": "guest",
    "sources": [
    {
    "type": "project",
    "id": "string",
    "name": "string",
    "role": "guest"
    }
    ],
    "capabilities": [
    "read"
    ]
    }
    }
    ],
    "total": 0,
    "page": 0,
    "pageSize": 0
    }
    }