API-314: changed schema validator to accept name of the property being validated so that it can be displayed in error. (#124)

Author: santoshaherkar

openapi-validator/src/main/java/com/networknt/openapi/RequestValidator.java

@@ -123,7 +123,7 @@ private Status validateRequestBody(Object requestBody, final OpenApiOperation op
         config.setTypeLoose(false);
         config.setHandleNullableField(ValidatorHandler.config.isHandleNullableField());
 
-        return schemaValidator.validate(requestBody, Overlay.toJson((SchemaImpl)specBody.getContentMediaType("application/json").getSchema()), config);
+        return schemaValidator.validate(requestBody, Overlay.toJson((SchemaImpl)specBody.getContentMediaType("application/json").getSchema()), config, "requestBody");
     }
 
     private Status validateRequestParameters(final HttpServerExchange exchange, final NormalisedPath requestPath, final OpenApiOperation openApiOperation) {
@@ -170,7 +170,7 @@ private Status validatePathParameters(final HttpServerExchange exchange, final N
 	                logger.info("Path parameter cannot be decoded, it will be used directly");
 	            }
 
-                return schemaValidator.validate(paramValue, Overlay.toJson((SchemaImpl)(parameter.get().getSchema())));
+                return schemaValidator.validate(paramValue, Overlay.toJson((SchemaImpl)(parameter.get().getSchema())), paramName);
             }
         }
         return status;
@@ -212,7 +212,7 @@ private Status validateQueryParameter(final HttpServerExchange exchange,
 
             Optional<Status> optional = queryParameterValues
                     .stream()
-                    .map((v) -> schemaValidator.validate(v, Overlay.toJson((SchemaImpl)queryParameter.getSchema())))
+                    .map((v) -> schemaValidator.validate(v, Overlay.toJson((SchemaImpl)queryParameter.getSchema()), queryParameter.getName()))
                     .filter(s -> s != null)
                     .findFirst();
 
@@ -221,7 +221,7 @@ private Status validateQueryParameter(final HttpServerExchange exchange,
         // Since if the queryParameterValue's length larger than 2, it means the query parameter is an array.
         // thus array validation should be applied, for example, validate the length of the array.
         } else {
-            return schemaValidator.validate(queryParameterValues, Overlay.toJson((SchemaImpl)queryParameter.getSchema()));
+            return schemaValidator.validate(queryParameterValues, Overlay.toJson((SchemaImpl)queryParameter.getSchema()), queryParameter.getName());
         }
         return null;
     }
@@ -321,7 +321,7 @@ private Status validateHeader(final HttpServerExchange exchange,
         } else {
             Optional<Status> optional = headerValues
                     .stream()
-                    .map((v) -> schemaValidator.validate(v, Overlay.toJson((SchemaImpl)headerParameter.getSchema())))
+                    .map((v) -> schemaValidator.validate(v, Overlay.toJson((SchemaImpl)headerParameter.getSchema()), headerParameter.getName()))
                     .filter(s -> s != null)
                     .findFirst();
             return optional.orElse(null);
@@ -340,7 +340,7 @@ private ValidationResult validateDeserializedValues(final HttpServerExchange exc
 		        	if (null==deserializedValue) {
 		        		validationResult.addSkipped(p);
 		        	}else {
-		        		Status s = schemaValidator.validate(deserializedValue, Overlay.toJson((SchemaImpl)(p.getSchema())));
+		        		Status s = schemaValidator.validate(deserializedValue, Overlay.toJson((SchemaImpl)(p.getSchema())), p.getName());
 		        		validationResult.addStatus(s);
 		        	}
 		        });

openapi-validator/src/main/java/com/networknt/openapi/SchemaValidator.java

@@ -81,14 +81,31 @@ public SchemaValidator(final OpenApi3 api) {
      * @return A status containing error code and description
      */
     public Status validate(final Object value, final JsonNode schema, SchemaValidatorsConfig config) {
-        return doValidate(value, schema, config);
+        return doValidate(value, schema, config, "$");
+    }
+
+    /**
+     * Validate the given value against the given property schema.
+     *
+     * @param value The value to validate
+     * @param schema The property schema to validate the value against
+     * @param config The config model for some validator
+     * @param at The name of the property being validated
+     * @return
+     */
+    public Status validate(final Object value, final JsonNode schema, SchemaValidatorsConfig config, String at) {
+        return doValidate(value, schema, config, at);
     }
 
     public Status validate(final Object value, final JsonNode schema) {
-        return doValidate(value, schema, defaultConfig);
+        return doValidate(value, schema, defaultConfig, "$");
+    }
+
+    public Status validate(final Object value, final JsonNode schema, String at) {
+        return doValidate(value, schema, defaultConfig, at);
     }
 
-    private Status doValidate(final Object value, final JsonNode schema, SchemaValidatorsConfig config) {
+    private Status doValidate(final Object value, final JsonNode schema, SchemaValidatorsConfig config, String at) {
         requireNonNull(schema, "A schema is required");
 
         Status status = null;
@@ -99,7 +116,7 @@ private Status doValidate(final Object value, final JsonNode schema, SchemaValid
             }
             JsonSchema jsonSchema = JsonSchemaFactory.getInstance().getSchema(schema, config);
             final JsonNode content = Config.getInstance().getMapper().valueToTree(value);
-            processingReport = jsonSchema.validate(content);
+            processingReport = jsonSchema.validate(content, content, at);
         } catch (Exception e) {
             e.printStackTrace();
         }