board-github
POST /v1/board-github/discover
List the GitHub Projects a credential can see.
සත්යාපනය
බෙරර් ටෝකනයක් ලෙස API යතුරක් යවන්න. මෙම අන්ත ලක්ෂ්යය පිරිවිතරයේ නිශ්චිත අවසරයක් දක්වා නැත, එබැවින් උපකල්පනය කරනවාට වඩා ඔබේ යතුරට අවශ්ය අවම අවසරය ලබා දී ප්රතිචාරය පරීක්ෂා කරන්න.
ඔry ඔබේ සංවිධාන හැඳුනුම් අංකය (organisation id) ඇතුළත් කරන ස්ථානය
මෙම අවසාන ලක්ෂ්යය JSON ශරීරයේ ක්ෂේත්රයක් ලෙස org_id ලබා ගනී.
ඔබගේ සංවිධාන ID එක ඔබගේ පාලක පුවරුවේ ඇති API යතුරු තිරයේ, යතුරට ඊළඟින් දක්වා ඇත. ඔබ සිදු කරන සෑම ඇමතුමකදීම ඇත්තේ එම ID එකමය.
උත්සාහ කරන්න
<අගයන්> සමඟ කෝණික වරහන් තුළ ඇති ඕනෑම දෙයක් සහ ඔබේ උපකරණ පුවරුවෙන් ලබාගත් යතුරක් සමඟ key ස්ථාන දායකය ප්රතිස්ථාපනය කරන්න.
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> }'පද්ධතියට පිවිස සිටිනවාද? ඔබගේ උපකරණ පුවරුවේ ඇති 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_login | string | ඔව් | — |
auth_kind | GitHubAuthKind | නැත | 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_id | string | නැත | — |
token | string | නැත | 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_id | string | නැත | — |
පsspil
| නම | වර්ගය | අත්යවශ්යයි | එය කුමක්ද |
|---|---|---|---|
owner_login | string | නැත | — |
count | integer | නැත | 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. |
projects | GitHubProjectSummary[] | නැත | — |
මෙම අවසාන ලක්ෂ්යය ආපසු ලබා දිය හැකි දෝෂ
401 · 403 · 422