ErrorDetail

מציג פרטים על שגיאה שגרמה לאימות או לכשל פנימי.

ייצוג JSON
{
  "code": integer,
  "field": string,
  "message": string,
  "value": string,
  "fieldIndex": integer
}
שדות
code

integer

קוד הסטטוס, שצריך להיות ערך enum של ErrorCode.

field

string

נתיב שמוביל לשדה בגוף הבקשה. הערך הזה הוא רצף של מזהים המופרדים באמצעות נקודות שמזהים שדה של מאגר נתונים זמני של פרוטוקול. לדוגמה, 'errorDetails.field' יזהה את השדה הזה.

message

string

תיאור של הסיבה לכשל בשדה. ההודעה כתובה באנגלית ויכול להיות שלא מתאימה להצגה למשתמשים.

value

string

הערך שנכשל עם הבקשה.

fieldIndex

integer

אם שדה הבקשה שיצר את השגיאה הזו חוזר על עצמו, הוא יכיל את האינדקס מבוסס האפס של הערך בשדה הזה, שהאימות נכשל.