Error

Form der Fehlerantwort

Alle Endpoints geben Fehler in diesem einheitlichen Envelope zurück.

{
  "success": false,
  "error": {
    "code":    "INVALID_URL",
    "status":  400,
    "message": "The provided URL is not valid",
    "details": null
  }
}

Felder

• success (boolean): bei Fehlern immer false
• error.code (string): maschinenlesbarer Fehlercode — siehe Fehlercodes
• error.status (number): HTTP-Statuscode (spiegelt den Antwortstatus; nützlich, wenn der rohe Status nicht verfügbar ist)
• error.message (string): menschenlesbare Fehlerbeschreibung
• error.details (object | null): strukturierter Kontext zum Fehler — z. B. feldbezogene Validierungsfehler als { field: message }-Paare bei INVALID_PARAMETER; null, falls nicht anwendbar

TypeScript-Typ

type ErrorResponse = {
  success: false;
  error: {
    code: string;       // machine-readable, e.g. "INVALID_URL"
    status: number;     // HTTP status code
    message: string;    // human-readable
    details: Record<string, unknown> | null;
  };
};

Stabiler Vertrag: Diese 4 error.*-Felder sind garantiert. Künftige Ergänzungen bleiben rückwärtskompatibel — Clients können unbekannte Felder gefahrlos ignorieren.