Using $ref with Relative Path

[akuzin1]

I am attempting to use $ref as part of a schema, in order to reference a repetitive schema definition in a separate file within the same directory.
However, after trying multiple path variations I still continue to receive a com.networknt.schema.JsonSchemaException: java.io.IOException stating that the "Resource common-definitions.json not found in classpath"

Main Schema

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "required" : ["DriverProperties"],
    "properties": {
        "DriverProperties": {
            "type": "object",
            "properties": {
                "CommonProperties": {
                    "$ref": "common-definitions.json#/definitions/DriverProperties"
                }
            },
            "required": ["CommonProperties"]
            "additionalProperties": false
        }
    },
    "additionalProperties": false
}

common-defintions.json:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "additionalProperties": false,
    "definitions": {
        "DriverProperties": {
            "type": "object",
            "properties": {
                "field1": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 512
                },
                "field2": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 512
                }
            },
            "required": ["field1"],
            "additionalProperties": false
        }
    }
}

Whenever I input the absolute path, referencing the external definition works. However, I want this to work on any machine, so I want to define the classpath relatively.
Any recommendations would be greatly appreciated.
Thank you.

[SudBisht]

have you tried this

"properties": { "CommonProperties": { "$ref": "classpath:///common-definitions.json#/definitions/DriverProperties" } }

[akuzin1]

Yes I have but unfortunately I get the same error. And when I try and add "$id": "/" to the schema, I get another error:

Caused by: com.networknt.schema.JsonSchemaException: #/properties/DriverProperties/properties/driverProperties/$ref: Reference common-definitions.json#/definitions/DriverProperties cannot be resolved

[Tjlastnumber]

try

factory.getSchema(uri);

Do not use

facotry.getSchema(string);

This could be a bug

[akuzin1]

Where should I try this?

[SudBisht]

tried this and working fine for me

Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "required" : ["DriverProperties"],
  "properties": {
    "DriverProperties": {
      "type": "object",
      "properties": {
        "CommonProperties": {
          "$ref": "classpath:///schema/common-definitions.json#/definitions/DriverProperties"
        }
      },
      "required": ["CommonProperties"],
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}


Test
ClassLoader classLoader = this.getClass().getClassLoader();

 @Test
  public void validInput_test() throws IOException {

    JsonSchemaFactory factory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V6);
    
    JsonSchema jsonSchema = factory.getSchema(IOUtils.toString(
       Objects.requireNonNull(classLoader.getResourceAsStream("schema/def.schema.json")),
        StandardCharsets.UTF_8.name()));
        
    JsonNode jsonNode = mapper.readTree(IOUtils.toString(
       Objects.requireNonNull(classLoader.getResourceAsStream("schema/def.valid.input.example.json")),
        StandardCharsets.UTF_8.name()));

    Set<ValidationMessage> errors = jsonSchema.validate(jsonNode);
    assertThat(errors).isEmpty();
  }
    
Input
{
  "DriverProperties": {
    "CommonProperties": {
      "field2": "abc-def-xyz"
    }
  }
}    

[akuzin1]

What does readFile do? Does it return a URI or an InputStream?
I am using version 1.0.83, would that possibly affect the behavior I'm experiencing?
What is the file structure of the example?

[SudBisht]

What does readFile do? Does it return a URI or an InputStream? I am using version 1.0.83, would that possibly affect the behavior I'm experiencing? What is the file structure of the example?

updated the above code,
readFile was returning String
version : 1.1.0
file structure: src/test/resources/schema