board-github

PUT `/v1/board-github/links/{linkId}/fields/{fieldId}/wip`

Set an advisory WIP limit on one status option.

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

curl -X PUT https://api.zinndigital.com/v1/board-github/links/{linkId}/fields/{fieldId}/wip \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "option_id": <string> }'

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

**GitHub has no WIP limit feature at all**, so this is new capability rather than a nicer rendering of theirs. It writes nothing to GitHub and cannot fail because of them. Advisory, exactly as a board column's limit is: a limit that *refused* a move would turn a management convention into an outage at 17:55 on a Friday — and here it would be refusing a write into somebody else's GitHub. `limit: null` clears it.

参数

名称	类型	必填	内容简介
`linkId (path)`	`string`	是	The GitHub Projects connection.
`fieldId (path)`	`string`	是	The project field, by OUR id.

请求正文

名称	类型	必填	内容简介
`option_id`	`string`	是	—
`limit`	`integer`	否	—

响应

名称	类型	必填	内容简介
`id`	`string`	否	—
`field_node_id`	`string`	否	—
`name`	`string`	否	—
`data_type`	`GitHubProjectFieldType`	否	Every field type Projects v2 exposes, spelled as GitHub spells it. The full set, not the four that are easy: a board that rendered TEXT/NUMBER/DATE/SELECT and silently dropped I…
`position`	`integer`	否	—
`options`	`object[]`	否	The select's options, or the iteration's sprints. Completed iterations are kept and marked rather than dropped — a sprint board whose finished sprints vanish cannot show a burn-…
`wip_limits`	`object`	否	Advisory cap per single-select option, keyed by option id. Ours, not GitHub's.
`writable`	`boolean`	否	Computed server-side from the type, so the UI never keeps its own copy of which types GitHub will accept. Two lists would drift, and the drift shows up as an editable control wh…

此端点可能返回的错误

401 · 403 · 404 · 422

PUT /v1/board-github/links/{linkId}/fields/{fieldId}/wip