@CompileStatic
class ResponseMetaDataValidationReportPart
extends Object

Part of the response metadata containing details about validation failures.

It is rendered only when violation failure occurs. It should not be rendered for any other failure type (domain, other or unknown).

An example of metadata JSON containing violation part rendered for validation failure can be seen in the following example:

 {
   "metaData": {
     "general": {
       "severity": "warning",
       "locale": "en_GB",
       "timestamp": "2020-04-26T09:41:04.917666Z"
     },
     "http": {
       "status": "400",
       "message": "Bad Request"
     },
     "violation": {
       "code": "400",
       "message": "Request is not valid.",
       "type": "validation",

       "validationReport": {
         root: { type: "myRequest", message: "Request myRequest is not valid." }
         constraintViolations: [
           { type: "customObjectLevelValidationType", scope: "object", path: "", message: "The combination of properties is not quite right." },
           { type: "notNull", scope: "property", path: "myProperty", message: "must not be null", invalidPropertyValue: "null" },
           { type: "notNull", scope: "property", path: "myOtherProperty", message: "must not be null", invalidPropertyValue: "null" },
           ...
         ]
       }
     }
   },
   "payload": {}
 }
 

See Also:

ValidationReportRoot

ValidationReportConstraintViolation