error.json

{
   "type":"object",
   "$schema":"http://json-schema.org/draft-04/hyper-schema#",
   "title":"error",
   "description":"Error details.",
   "properties":{
      "name":{
         "type":"string",
         "description":"Human readable, unique name of the error. It is recommended that this value is streamed out in error response from catalog's error_spec.json#name."
      },
      "debug_id":{
         "type":"string",
         "description":"Internal identifier used for correlation purposes."
      },
      "message":{
         "type":"string",
         "description":"Message describing the error. It is recommended that this value is streamed out in error response from catalog's error_spec.json#message."
      },
      "information_link":{
         "type":"string",
         "description":"URI for detailed information related to this error for the developer. It is recommended that this value is streamed out in error response from one of the links from catalog's error_spec.json#links."
      },
      "details":{
         "type":"array",
         "description":"Additional details for the error. Mandatory for client side 4xx errors.",
         "additionalItems":false,
         "items":{
            "$ref":"error_details.json"
         }
      },
      "links":{
            "type":"array",
            "description":"Error context specific HATEOAS links",
            "items":{
              "$ref":"http://json-schema.org/draft-04/hyper-schema#/definitions/linkDescription"
            }
        }
   },
   "required" : [ "name", "debug_id", "message"]
}