הודעה שמייצגת בקשת משיכה (Pull Request) ב-SCM.
| ייצוג ב-JSON |
|---|
{ "id": string, "title": string, "body": string, "headRef": string, "baseRef": string, "author": string, "createTime": string, "updateTime": string, "mergeTime": string, "closeTime": string, "declineTime": string, "state": enum ( |
| שדות | |
|---|---|
id |
חובה. המזהה של בקשת ה-Pull. |
title |
חובה. השם של בקשת ה-Pull. |
body |
זה שינוי אופציונלי. תיאור הגוף של בקשת ה-Pull. |
headRef |
חובה. ה-SHA של השמירה במקור של הענף הראשי. |
baseRef |
חובה. ה-SHA של ה-commit ל-base branch. |
author |
פלט בלבד. שם המשתמש של המחבר. |
createTime |
פלט בלבד. מתי נוצרה בקשת ה-Pull. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
updateTime |
פלט בלבד. מתי בקשת ה-PR עודכנה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
mergeTime |
פלט בלבד. מתי בקשת ה-Pull מוזגה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
closeTime |
פלט בלבד. מתי בקשת ה-PR נסגרה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
declineTime |
פלט בלבד. מתי בקשת התיקון נדחתה. ההגדרה הזו רלוונטית רק לספקי SCM שתומכים בדחיית בקשות משיכה. הערך הזה אף פעם לא מוגדר ל-GitHub, ל-GitHub Enterprise, ל-GitLab או ל-GitLab Enterprise, שבהם בקשת משיכה שנסגרה בלי מיזוג היא הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
state |
פלט בלבד. המצב הנוכחי של בקשת ה-Pull. |
mergeability |
פלט בלבד. מצב המיזוג של בקשת המשיכה. |
htmlUrl |
פלט בלבד. כתובת ה-HTML של בקשת משיכה (pull request) אצל ספק ה-SCM. |
מדינה
הסטטוס של בקשת ה-Pull.
| טיפוסים בני מנייה (enum) | |
|---|---|
STATE_UNSPECIFIED |
ערך ברירת המחדל. |
OPEN |
בקשת ה-PR פתוחה. |
CLOSED |
בקשת ה-PR נסגרה. |
MERGED |
בקשת ה-PR מוזגה. |
DECLINED |
בקשת ה-PR נדחית. ההרשאה הזו משמשת רק ספקי SCM שתומכים בדחיית בקשות משיכה. הערך הזה לא משמש אף פעם ל-GitHub, ל-GitHub Enterprise, ל-GitLab או ל-GitLab Enterprise, שבהם בקשת משיכה שנסגרה בלי מיזוג היא CLOSED. |
אפשרות מיזוג
מצב המיזוג של בקשת משיכה.
| טיפוסים בני מנייה (enum) | |
|---|---|
MERGEABILITY_UNSPECIFIED |
לא צוין מצב יכולת המיזוג. |
MERGEABLE |
אפשר למזג את בקשת משיכה (pull request) בצורה נקייה בלי התנגשויות ב-Git. |
CONFLICTING |
יש בבקשת ה-pull התנגשויות מיזוג, ואי אפשר למזג אותה בצורה נקייה. |
COMPUTING |
מצב המיזוג מחושב כרגע באופן אסינכרוני על ידי ספק ה-SCM במעלה הזרם. |