API 参考 / custom-fields

新增缺陷自定义字段定义

POST /api/v1/projects/{projectId}/bug-fields · createProjectBugField

为「缺陷」定义一个自定义字段（走 custom-data 的 AddField，config 经 S2 校验）。需要 manage_project_settings。写命令在 TenantTx 内产 ChangeSet + entity_field.added Event。非法 config / 重复 key 返回 422。

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

参数

projectId（必填）: string

请求体

key（必填）: string
label: string
dataType（必填）: enum；取值：text / number / bool / date / select
required: boolean
unique: boolean
config: object

响应字段 · 201

id（必填）: string
key（必填）: string
label（必填）: string
dataType（必填）: enum；取值：text / number / bool / date / select
required（必填）: boolean
unique（必填）: boolean
config（必填）: object

错误

401：Problem 错误响应
403：Problem 错误响应
422：Problem 错误响应

请求示例（curl）

curl -X POST "https://你的项目.workflow.games/api/v1/projects/{projectId}/bug-fields" \
  -H "Authorization: Bearer wfp_…" \
  -H "content-type: application/json" \
  --data '{"key":"示例文本","dataType":"text","label":"示例文本"}'

响应示例

HTTP/1.1 201
{
  "id": "018f3c2e-0000-7000-8000-000000000000",
  "key": "示例文本",
  "label": "示例文本",
  "dataType": "text",
  "required": true,
  "unique": true,
  "config": "示例文本"
}

合同真值：OpenAPI 3.1（0.1.0）。

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