board-github

POST /v1/board-github/discover

List the GitHub Projects a credential can see.

Ҳамаи нуқтаҳои ниҳоии board-github

Ҳамаи ҳуҷҷатҳои таҳиякунандагон

Санҷиши ҳаққоният

Kalitи API-ро ҳамчун token-и bearer фиристед. Ин нуқтаи ниҳоӣ дар мушаххасот иҷозати мушаххасеро нишон намедиҳад, бинобар ин ба калиди худ ҳадди ақали заруриро диҳед ва ба ҷои тахмин кардан, ҷавобро санҷед.

Ҷое, ки рақами мушаххаси ташкилоти шумо ҷойгир аст

Ин нуқтаи поёнӣ org_id -ро ҳамчун майдон дар бадани JSON мегирад.

Rakami муайянкунандаи ташкилоти шумо дар экрани калидҳои API дар панели идоракунии шумо, дар паҳлӯи худи калид ҷойгир аст. Ин як раками муайянкунанда дар ҳар یک дархосте, ки шумо иҷро мекунед, якхела аст.

Санҷидан

Ҳар чизро дар қаavски кунҷӣ бо қиматҳои худ ва ҷойи нигоҳдорандаи калидро бо калима аз панели идоракунии худ иваз кунед.

curl -X POST https://api.zinndigital.com/v1/board-github/discover \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "owner_login": <string> }'

Воarid шудаед? Консоли API дар панели идоракунии шумо рақами мушаххаси ташкилоти воқеӣ ва калиди худро пур мекунад ва дархостро бар зидди API-и фаъол иҷро мекунад, то шумо посухи воқеиро бубинед. Ин нуқтаи ниҳоиро дар консоли API кушоед

Тафсилот

Asked before anything is linked, so the customer picks a project from a list rather than pasting a node id. Reads both owner shapes — GitHub's organization query returns null for a user login and user returns null for an org login, so a single-shape read would answer "no projects" for half of all customers with no error anywhere. count is returned beside projects deliberately: an owner with genuinely no projects and a credential that cannot see any would otherwise be the same empty array.

Ҷисми дархост

НомНамудТалаб карда мешавадИн чӣ аст
owner_loginstringБале
auth_kindGitHubAuthKindНеapp is the Zinn® GitHub App installation — per-repository scope the customer chooses on GitHub's own screen, revocable by them in one click, belonging to their organisation…
installation_idstringНе
tokenstringНеA fine-grained token, for auth_kind: pat. Write-only and never echoed — a response carrying it would put a live GitHub credential in the browser's network tab and in any log…
org_idstringНе

Ҷавоб

НомНамудТалаб карда мешавадИн чӣ аст
owner_loginstringНе
countintegerНеReturned beside the list on purpose. An owner with genuinely no projects and a credential that cannot see any would otherwise be the same empty array.
projectsGitHubProjectSummary[]Не

Хатоҳое, ки ин нуқтаи ниҳоӣ метавонад баргардонад

401 · 403 · 422