הסוג Status
מגדיר מודל שגיאה לוגי שמתאים לסביבות תכנות שונות, כולל ממשקי API ל-REST וממשקי API מסוג RPC. הוא בשימוש על ידי gRPC. כל הודעת Status
מכילה שלושה נתונים: קוד שגיאה, הודעת שגיאה ופרטי שגיאה.
מידע נוסף על מודל השגיאה הזה ועל אופן העבודה איתו זמין במדריך לתכנון API.
ייצוג JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
שדות | |
---|---|
code |
קוד הסטטוס, שאמור להיות ערך |
message |
הודעת שגיאה שמוצגת למפתח, שכתובה באנגלית. כל הודעת שגיאה שמוצגת למשתמש צריכה להיות מותאמת לשוק המקומי ולשלוח אותה בשדה |
details[] |
רשימה של הודעות שמכילות את פרטי השגיאה. קיימת קבוצה משותפת של סוגי הודעות שבהם ממשקי API יוכלו להשתמש. אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף |