Validation Failed

validation-error · 400

لم يجتز الطلب التحقق قبل تنفيذ أي شيء، فلم يكتب أي شيء.

كل الصفحات

في errors[] عنصر لكل حقل لم ينجح، وكلها دفعة واحدة. عندما ترفضه فحوص الجسم نفسها، يكون الـ detail الجملة نفسها دائما، والتفاصيل في errors[]. ونطاق السجلات المخصص الذي ليس نطاقا صحيحا يعيد النوع نفسه، لكن الحل في detail ولا يوجد errors[].

إضافة إلى الحقول التي في كل خطأ، يضيف هذا النوع errors.

الأسباب الشائعة

  • حقل فيه قيمة من نوع خاطئ، مثل نص مكان رقم أو object.
  • قيمة خارج مجموعة محددة، مثل type للخدمة غير git أو database أو cache أو postgres أو mysql أو redis.
  • حقل مطلوب ناقص، أو في الجسم حقل لا تعرفه الـ API. الحقل غير المعروف يرفض ولا يتجاهل، فالاسم المكتوب خطأ يفشل هنا.
  • قائمة الـ IP المسموحة فيها عناوين لا تصلح. لكل عنوان عنصر خاص به، مثل ip_allowlist[2]، ولا يسجل أي شيء.

كيف تصلح الطلب

  • اقرأ errors[] لا detail. في كل عنصر field، وهو مسار بالنقاط داخل الجسم (entries.0.kind هو الـ kind لأول عنصر في entries)، ومعه message والقيمة value التي أرسلتها.
  • عندما يكون للحقل قيم محددة، يحمل عنصره allowedValues. أرسل واحدة منها كما هي مكتوبة تماما.
  • أصلح كل العناصر قبل أن تعيد المحاولة. المحاولة التي تصلح العنصر الأول فقط ستفشل في الباقي.
  • عندما لا يوجد errors[]، يخبرك الـ detail بما تغيره.
  • لا ترسل الجسم نفسه مرة أخرى، فلا شيء فيه سينجح لاحقا.

مثال على الرد

json
{
  "type": "validation-error",
  "title": "Validation Failed",
  "status": 400,
  "detail": "One or more validation errors occurred",
  "errors": [
    {
      "field": "type",
      "message": "type must be one of the following values: git, database, cache, postgres, mysql, redis",
      "value": "worker",
      "constraints": [
        "isIn"
      ],
      "allowedValues": [
        "git",
        "database",
        "cache",
        "postgres",
        "mysql",
        "redis"
      ]
    },
    {
      "field": "name",
      "message": "name must be lowercase letters, digits, and single hyphens",
      "value": "My App",
      "constraints": [
        "matches"
      ]
    }
  ],
  "requestId": "req-1785231000000-4f7b2c9ae",
  "timestamp": "2026-07-28T09:30:00.000Z",
  "path": "/v1/projects/0199e0a3-6f21-7c4a-9d18-2b7c5f3ad401/services",
  "method": "POST",
  "instance": "POST /v1/projects/0199e0a3-6f21-7c4a-9d18-2b7c5f3ad401/services",
  "docs": "https://ghaym.me/docs/errors/validation-error"
}