board-github
GET /v1/board-github/roadmap
A dated timeline across every linked GitHub Project.
احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی org_id را به عنوان یک پارامتر پرسوجو میپذیرد. آن را رها کنید تا فراخوانی کل زیردرخت اجارهای شما را پوشش دهد؛ آن را ارسال کنید تا فراخوانی به یک سازمان محدود شود.
شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواستهایی که ارسال میکنید یکسان است.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/board-github/roadmap \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
Built from whichever DATE and ITERATION fields each project actually has. Lanes are the iteration where a project has one and the project where it does not, so one timeline stays readable across a sprint-driven engineering project and a date-driven client project at once. GitHub's own roadmap layout can do neither — it is per-project and cannot see our board cards. Items with no date are **omitted and counted** in `items_without_dates`, never given an invented date: a chart of our guesses would be worse than a gap.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
org_id (query) | string | خیر | — |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
count | integer | خیر | — |
items_without_dates | integer | خیر | Omitted from the timeline and counted here. A chart that invented a date for undated work would be a chart of our guesses. |
coverage_is_complete | boolean | خیر | — |
entries | GitHubProjectRoadmapEntry[] | خیر | — |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 422