error-body.json

{
  "type": "array",
  "title": "Error Body",
  "description": "Der Inhalt (Body) von HTTP Responses bei Fehlern.",
  "minItems": 1,
  "items": {
    "type": "object",
    "title": "Error",
    "description": "Rückmeldung zu einer nicht erfolgreichen Operation",
    "additionalProperties": false,
    "properties": {
      "code": {
        "type": "integer",
        "description": "Fehlercode"
      },
      "msg": {
        "type": "string",
        "description": "Fehlermeldung"
      },
      "ref": {
        "type": "string",
        "description": "Referenz auf die Stelle, an der der Fehler aufgetreten ist. Dies könnte z.B. eine Zeilennummer oder der Pfad eines JSON oder XML Elements sein."
      }
    },
    "required": [
      "code",
      "msg"
    ]
  },
  "x-examples": {
    "example-1": [
      {
        "code": 400,
        "msg": "Document with id 1 already exists for application : 0c508e3f-2353-4206-9a1e-34b2e864d5a8"
      }
    ]
  }
}