board-github

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

Set an advisory WIP limit on one status option.

Все эндпоинты board-github

Аутентификация

Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

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 в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему 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_idstringДа
limitintegerНет

Ответ

ИмяТипОбязательноЧто это
idstringНет
field_node_idstringНет
namestringНет
data_typeGitHubProjectFieldTypeНет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…
positionintegerНет
optionsobject[]Нет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_limitsobjectНетAdvisory cap per single-select option, keyed by option id. Ours, not GitHub's.
writablebooleanНет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