board-github
PUT /v1/board-github/links/{linkId}/fields/{fieldId}/wip
Set an advisory WIP limit on one status option.
Autenticazione
Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.
Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
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> }'Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
**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.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
linkId (path) | string | Sì | The GitHub Projects connection. |
fieldId (path) | string | Sì | The project field, by OUR id. |
Corpo della richiesta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
option_id | string | Sì | — |
limit | integer | No | — |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
id | string | No | — |
field_node_id | string | No | — |
name | string | No | — |
data_type | GitHubProjectFieldType | No | 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 | No | — |
options | object[] | No | 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 | No | Advisory cap per single-select option, keyed by option id. Ours, not GitHub's. |
writable | boolean | No | 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… |
Errori che questo endpoint può restituire
401 · 403 · 404 · 422