API 参考 / project-config

更新项目配置

PUT /api/v1/projects/{projectId}/config · updateProjectConfig

整份覆盖项目配置。需要 manage_project_settings。写命令在 TenantTx 事务内产 ChangeSet + project_config.updated Event（payload 带 changedFields from/to）。

鉴权：项目 API Token（Authorization: Bearer wfp_…）。详见 Agent 接入。

参数

projectId（必填）
string

请求体

modules（必填）
string[]
departments（必填）
string[]
fieldLabels（必填）
ProjectFieldLabels —— 左侧导航模块显示名覆盖。仅 requirements/work/bugs/milestones 生效；缺省 key 沿用默认文案。
fieldLabels.requirements
string
fieldLabels.work
string
fieldLabels.bugs
string
fieldLabels.milestones
string
aiEnabled（必填）
boolean
feishuWebhookUrl
string —— 飞书群机器人 webhook 新值（write-only）。非空必须是飞书官方域 + https（SSRF 白名单），否则 422。为空表示「不改」（除非 clearFeishuWebhook=true）——因 GET 不回显 URL 明文，整份 PUT 回显空值时须保留现有配置，不误清。
clearFeishuWebhook
boolean —— 显式清除飞书 webhook（置空）。true 时忽略 feishuWebhookUrl、清空该项目 webhook（关闭 IM 投递降级为只站内）。缺省 false。

响应字段 · 200

modules（必填）
string[]
departments（必填）
string[]
fieldLabels（必填）
ProjectFieldLabels —— 左侧导航模块显示名覆盖。仅 requirements/work/bugs/milestones 生效；缺省 key 沿用默认文案。
fieldLabels.requirements
string
fieldLabels.work
string
fieldLabels.bugs
string
fieldLabels.milestones
string
aiEnabled（必填）
boolean
feishuWebhookConfigured
boolean —— 飞书 webhook 是否已配置（T4.4）。**write-only 密钥范式：GET 只回显是否已配，绝不回显 URL 明文**——webhook URL 路径含机器人 token，任何 view_project 只读成员都能读到会造成密钥泄漏。设置/清除经 UpdateProjectConfigRequest 的 feishuWebhookUrl / clearFeishuWebhook。缺省 false（未配）。

错误

请求示例（curl）

curl -X PUT "https://你的项目.workflow.games/api/v1/projects/{projectId}/config" \
  -H "Authorization: Bearer wfp_…" \
  -H "content-type: application/json" \
  --data '{"modules":["示例文本"],"departments":["示例文本"],"fieldLabels":{"requirements":"示例文本","work":"示例文本","bugs":"示例文本"},"aiEnabled":true}'

响应示例

HTTP/1.1 200
{
  "modules": [
    "示例文本"
  ],
  "departments": [
    "示例文本"
  ],
  "fieldLabels": {
    "requirements": "示例文本",
    "work": "示例文本",
    "bugs": "示例文本"
  },
  "aiEnabled": true
}

合同真值：OpenAPI 3.1（0.1.0）。

相关：Agent 接入指南 · 使用指南 · API 参考索引

Workflow 正在加载…