אינדקס
Status
(הודעה)
סטטוס
סוג Status
מגדיר מודל שגיאות לוגית שמתאים לסביבות תכנות שונות, כולל API ל-REST וממשקי API של RPC. הוא נמצא בשימוש של gRPC. כל הודעת Status
מכילה שלושה קטעי נתונים: קוד שגיאה, הודעת שגיאה ופרטי שגיאה.
מידע נוסף על מודל השגיאה הזה ועל אופן הפעולה שלו זמין במדריך לעיצוב API.
שדות | |
---|---|
code |
קוד הסטטוס, שאמור להיות ערך enum של |
message |
הודעת שגיאה שמוצגת למפתח, שאמורה להיות באנגלית. כל הודעת שגיאה שמוצגת למשתמש צריכה להיות מותאמת לשוק המקומי ולשלוח אותה בשדה |
details[] |
רשימה של הודעות עם פרטי השגיאה. יש קבוצה משותפת של סוגי הודעות שאפשר להשתמש בהם בממשקי API. |