board-github

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

Set an advisory WIP limit on one status option.

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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> }'

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

**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.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`linkId (path)`	`string`	Sim	The GitHub Projects connection.
`fieldId (path)`	`string`	Sim	The project field, by OUR id.

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`option_id`	`string`	Sim	—
`limit`	`integer`	Não	—

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`string`	Não	—
`field_node_id`	`string`	Não	—
`name`	`string`	Não	—
`data_type`	`GitHubProjectFieldType`	Não	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`	Não	—
`options`	`object[]`	Não	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`	Não	Advisory cap per single-select option, keyed by option id. Ours, not GitHub's.
`writable`	`boolean`	Não	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…

Erros que este endpoint pode retornar

401 · 403 · 404 · 422

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