API 参考 / project-config

读取项目配置

GET /api/v1/projects/{projectId}/config · getProjectConfig

读取项目级配置(模块 / 部门 / 字段命名 / AI 开关)。首份读取时若无配置行返回默认配置。 需要 view_project(项目成员)。

鉴权:项目 API Token(Authorization: Bearer wfp_…)。详见 Agent 接入。

参数

projectId(必填)
string

响应字段 · 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 GET "https://你的项目.workflow.games/api/v1/projects/{projectId}/config" \
  -H "Authorization: Bearer wfp_…"

响应示例

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

合同真值:OpenAPI 3.1(0.1.0)。

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

Workflow 正在加载…