Support custom message per property

Author: justin-tay

doc/cust-msg.md

@@ -6,7 +6,7 @@ The json schema itself has a place for the customised message.
 ## Examples
 ### Example 1 :
 The custom message can be provided outside properties for each type, as shown in the schema below.
-````json
+```json
 {
   "type": "object",
   "properties": {
@@ -24,10 +24,10 @@ The custom message can be provided outside properties for each type, as shown in
     "type" : "Invalid type"
   }
 }
-````
+```
 ### Example 2 :
 To keep custom messages distinct for each type, one can even give them in each property.
-````json
+```json
 {
   "type": "object",
   "properties": {
@@ -47,14 +47,62 @@ To keep custom messages distinct for each type, one can even give them in each p
     }
   }
 }
-````
+```
+### Example 3 :
+For the keywords `required` and `dependencies`, different messages can be specified for different properties.
+
+```json
+{
+  "type": "object",
+  "properties": {
+    "foo": {
+      "type": "number"
+    },
+    "bar": {
+      "type": "string"
+    }
+  },
+  "required": ["foo", "bar"],
+  "message": {
+    "type" : "should be an object",
+    "required": {
+      "foo" : "'foo' is required",
+      "bar" : "'bar' is required"
+    }
+  }
+}
+```
+### Example 4 :
+The message can use arguments but note that single quotes need to be escaped as `java.text.MessageFormat` will be used to format the message.
+
+```json
+{
+  "type": "object",
+  "properties": {
+    "foo": {
+      "type": "number"
+    },
+    "bar": {
+      "type": "string"
+    }
+  },
+  "required": ["foo", "bar"],
+  "message": {
+    "type" : "should be an object",
+    "required": {
+      "foo" : "{0}: ''foo'' is required",
+      "bar" : "{0}: ''bar'' is required"
+    }
+  }
+}
+```
 
 ## Format
-````json
+```json
 "message": {
     [validationType] : [customMessage]
   }
-````
+```
 Users can express custom message in the **'message'** field. 
 The **'validation type'** should be the key and the **'custom message'** should be the value.
 

src/main/java/com/networknt/schema/AdditionalPropertiesValidator.java

@@ -97,7 +97,7 @@ public Set<ValidationMessage> validate(ExecutionContext executionContext, JsonNo
 
             if (!allowedProperties.contains(pname) && !handledByPatternProperties) {
                 if (!allowAdditionalProperties) {
-                    errors.add(buildValidationMessage(at, executionContext.getExecutionConfig().getLocale(), pname));
+                    errors.add(buildValidationMessage(null, at, executionContext.getExecutionConfig().getLocale(), pname));
                 } else {
                     if (additionalPropertiesSchema != null) {
                         ValidatorState state = (ValidatorState) collectorContext.get(ValidatorState.VALIDATOR_STATE_KEY);

src/main/java/com/networknt/schema/AnyOfValidator.java

@@ -77,8 +77,8 @@ public Set<ValidationMessage> validate(ExecutionContext executionContext, JsonNo
                         //If schema has type validator and node type doesn't match with schemaType then ignore it
                         //For union type, it is a must to call TypeValidator
                         if (typeValidator.getSchemaType() != JsonType.UNION && !typeValidator.equalsToSchemaType(node)) {
-                            allErrors.add(buildValidationMessage(at, executionContext.getExecutionConfig().getLocale(),
-                                    typeValidator.getSchemaType().toString()));
+                            allErrors.add(buildValidationMessage(null, at,
+                                    executionContext.getExecutionConfig().getLocale(), typeValidator.getSchemaType().toString()));
                             continue;
                         }
                     }
@@ -107,8 +107,8 @@ public Set<ValidationMessage> validate(ExecutionContext executionContext, JsonNo
                         if (this.discriminatorContext.isDiscriminatorMatchFound()) {
                             if (!errors.isEmpty()) {
                                 allErrors.addAll(errors);
-                                allErrors.add(buildValidationMessage(at,
-                                        executionContext.getExecutionConfig().getLocale(), DISCRIMINATOR_REMARK));
+                                allErrors.add(buildValidationMessage(null,
+                                        at, executionContext.getExecutionConfig().getLocale(), DISCRIMINATOR_REMARK));
                             } else {
                                 // Clear all errors.
                                 allErrors.clear();
@@ -135,8 +135,8 @@ public Set<ValidationMessage> validate(ExecutionContext executionContext, JsonNo
 
             if (this.validationContext.getConfig().isOpenAPI3StyleDiscriminators() && this.discriminatorContext.isActive()) {
                 final Set<ValidationMessage> errors = new HashSet<>();
-                errors.add(buildValidationMessage(at, executionContext.getExecutionConfig().getLocale(),
-                        "based on the provided discriminator. No alternative could be chosen based on the discriminator property"));
+                errors.add(buildValidationMessage(null, at,
+                        executionContext.getExecutionConfig().getLocale(), "based on the provided discriminator. No alternative could be chosen based on the discriminator property"));
                 return Collections.unmodifiableSet(errors);
             }
         } finally {

src/main/java/com/networknt/schema/ConstValidator.java

@@ -36,12 +36,12 @@ public Set<ValidationMessage> validate(ExecutionContext executionContext, JsonNo
 
         if (schemaNode.isNumber() && node.isNumber()) {
             if (schemaNode.decimalValue().compareTo(node.decimalValue()) != 0) {
-                return Collections.singleton(buildValidationMessage(at,
-                        executionContext.getExecutionConfig().getLocale(), schemaNode.asText()));
+                return Collections.singleton(buildValidationMessage(null,
+                        at, executionContext.getExecutionConfig().getLocale(), schemaNode.asText()));
             }
         } else if (!schemaNode.equals(node)) {
             return Collections.singleton(
-                    buildValidationMessage(at, executionContext.getExecutionConfig().getLocale(), schemaNode.asText()));
+                    buildValidationMessage(null, at, executionContext.getExecutionConfig().getLocale(), schemaNode.asText()));
         }
         return Collections.emptySet();
     }

src/main/java/com/networknt/schema/ContainsValidator.java

@@ -112,6 +112,6 @@ public void preloadJsonSchema() {
     }
 
     private Set<ValidationMessage> boundsViolated(String messageKey, Locale locale, String at, int bounds) {
-        return Collections.singleton(buildValidationMessage(at, messageKey, locale, String.valueOf(bounds), this.schema.getSchemaNode().toString()));
+        return Collections.singleton(buildValidationMessage(null, at, messageKey, locale, String.valueOf(bounds), this.schema.getSchemaNode().toString()));
     }
 }

src/main/java/com/networknt/schema/DependenciesValidator.java

@@ -62,8 +62,8 @@ public Set<ValidationMessage> validate(ExecutionContext executionContext, JsonNo
             if (deps != null && !deps.isEmpty()) {
                 for (String field : deps) {
                     if (node.get(field) == null) {
-                        errors.add(buildValidationMessage(at, executionContext.getExecutionConfig().getLocale(),
-                                propertyDeps.toString()));
+                        errors.add(buildValidationMessage(pname, at,
+                                executionContext.getExecutionConfig().getLocale(), propertyDeps.toString()));
                     }
                 }
             }

src/main/java/com/networknt/schema/DependentRequired.java

@@ -56,8 +56,8 @@ public Set<ValidationMessage> validate(ExecutionContext executionContext, JsonNo
             if (dependencies != null && !dependencies.isEmpty()) {
                 for (String field : dependencies) {
                     if (node.get(field) == null) {
-                        errors.add(buildValidationMessage(at, executionContext.getExecutionConfig().getLocale(), field,
-                                pname));
+                        errors.add(buildValidationMessage(pname, at, executionContext.getExecutionConfig().getLocale(),
+                                field, pname));
                     }
                 }
             }

src/main/java/com/networknt/schema/EnumValidator.java

@@ -82,7 +82,7 @@ public Set<ValidationMessage> validate(ExecutionContext executionContext, JsonNo
 
         if (node.isNumber()) node = DecimalNode.valueOf(node.decimalValue());
         if (!nodes.contains(node) && !( this.validationContext.getConfig().isTypeLoose() && isTypeLooseContainsInEnum(node))) {
-            return Collections.singleton(buildValidationMessage(at, executionContext.getExecutionConfig().getLocale(), error));
+            return Collections.singleton(buildValidationMessage(null, at, executionContext.getExecutionConfig().getLocale(), error));
         }
 
         return Collections.emptySet();

src/main/java/com/networknt/schema/ErrorMessageType.java

@@ -16,6 +16,8 @@
 
 package com.networknt.schema;
 
+import java.util.Map;
+
 public interface ErrorMessageType {
     /**
      * Your error code. Please ensure global uniqueness. Builtin error codes are sequential numbers.
@@ -26,7 +28,7 @@ public interface ErrorMessageType {
      */
     String getErrorCode();
 
-    default String getCustomMessage() {
+    default Map<String, String> getCustomMessage() {
         return null;
     }
 

src/main/java/com/networknt/schema/ExclusiveMaximumValidator.java

@@ -107,8 +107,8 @@ public Set<ValidationMessage> validate(ExecutionContext executionContext, JsonNo
         }
 
         if (typedMaximum.crossesThreshold(node)) {
-            return Collections.singleton(buildValidationMessage(at, executionContext.getExecutionConfig().getLocale(),
-                    typedMaximum.thresholdValue()));
+            return Collections.singleton(buildValidationMessage(null, at,
+                    executionContext.getExecutionConfig().getLocale(), typedMaximum.thresholdValue()));
         }
         return Collections.emptySet();
     }