Upgrading from 1.0.8x to current (1.5.9): How to migrate "String at" to JsonNodePath and "String schemaPath" to SchemaLocation in custom ValidationMessages?

[AndreasALoew]

Hello Experts,

many thanks for having created such a great and fast validation library! 👍

I am in the process of migrating our app to Spring Boot 3.5 and Jakarta EE 11, and as part of this, from json-schema-validator 1.0.87 to the latest and greatest 1.5.9. The Upgrading to new versions document was a big help, but one topic remains, and even after asking several AIs (which started "hallucinating" and proposing to call methods that never existed 😠), I have two questions left that I seem unable to resolve on my own and hope for your kind help:

At several places in our codebase, with 1.0.8x, we have constructed custom ValidationMessages using ValidationMessage.of(), passing information from an com.networknt.openapi.OpenApiOperation (from the networknt "openapi-parser" library), making use of the openApiOperation in the String at and the String schemaPath parameters of the previous "static constructor" method ValidationMessage.of().

Example:

return Collections.singleton(ValidationMessage.of(OpenAPIConfigurationValidatorTypeCode.OPEN_API_TYPE,
                        OpenAPIConfigurationValidatorTypeCode.VALIDATOR_REQUEST_BODY_MISSING, "",
                        openApiOperation.getMethod(), openApiOperation.getPathString().original()));

In this case, String at is the fourth parameter of ValidationMessage.of(), where we used to pass openApiOperation.getMethod().

In addition, it looks like a similar issue exists with the fifth (= last) parameter (used to be String schemaPath - where we used to pass openApiOperation.getPathString().original() - , now needs to become schemaLocation(SchemaLocation schemaLocation)...

I am perfectly aware that I need to migrate this to the new approach using ValidationMessage.builder(), and also think that instanceLocation(JsonNodePath instanceLocation) and schemaLocation(SchemaLocation schemaLocation) would be the right builder methods to add the location info as before, but I simply cannot figure out the answer to the following two questions:

1. How exactly (code sample/fragment preferred) do I migrate/transform the JSON path-like String at from version 1.0.8x inside the Validation message to the new Builder approach based on com.jayway.jsonpath.JsonPath (I think I have to start using JsonPath.compile(at), right?) and JsonNodePath (and possibly Jackson's com.fasterxml.jackson.databind.JsonNode), such that the ValidationMessage instance that I create with 1.5.9 still transports the same information as with 1.0.8x?

2. Again/very similar: How exactly (code sample/fragment preferred) do I migrate/transform the JSON path-like String schemaPath from version 1.0.8x inside the Validation message to the new Builder approach based on SchemaLocation, such that the ValidationMessage instance that I create with 1.5.9 still transports the same information as with 1.0.8x?

Any pointers and/or code fragments highly appreciated! 😃

Thanks a million & kind regards,
Andreas

[justin-tay]

You can actually just look at how some of the validators are currently implemented and would typically just call message() from the base validator class.

json-schema-validator/src/main/java/com/networknt/schema/ConstValidator.java

Lines 41 to 44 in e78c388

	return Collections.singleton(message().instanceNode(node).instanceLocation(instanceLocation)
	.locale(executionContext.getExecutionConfig().getLocale())
	.failFast(executionContext.isFailFast()).arguments(schemaNode.asText(), node.asText())
	.build());

This calls the following to set up most of the default values

json-schema-validator/src/main/java/com/networknt/schema/ValidationMessageHandler.java

Lines 74 to 82 in e78c388

	protected MessageSourceValidationMessage.Builder message() {
	return MessageSourceValidationMessage.builder(this.messageSource, this.errorMessage, (message, failFast) -> {
	if (failFast) {
	throw new FailFastAssertionException(message);
	}
	}).code(getErrorMessageType().getErrorCode()).schemaLocation(this.schemaLocation)
	.evaluationPath(this.evaluationPath).type(this.keyword != null ? this.keyword.getValue() : null)
	.messageKey(getErrorMessageType().getErrorCodeValue());
	}

The value of at is referencing the instanceLocation. You will generally have access to the parent and you can call append if there are changes to the path.

[AndreasALoew]

@justin-tay , many thanks for the quick reply! 👍

As I will be travelling to Berlin and only return late on Friday, please bear with me for my feedback whether I have been successful with your suggestions until the weekend/Monday. Looks like it will still be anything but straightforward... 😉 😢

Did I get you right in that you propose that our validation class as the very first thing needs to extend BaseJsonValidator in order to "automagically" provide values for schemaLocation and instanceLocation etc.? I hope this turns out to be feasible...

Looking forward to trying out your suggestions... 😄

[justin-tay]

If you are creating a custom keyword validator then you would be extending BaseJsonValidator, implement Keyword to return the validator and register the keyword with a meta schema or vocabulary.