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