How to use definitions from external files in JSON Schema?

Question

I'm trying to import the definitions from another json schema using $ref but getting the following error:

can't resolve reference ../base/definitions.schema.json#/definitions/datetime from id #

{
  "$schema": "http://json-schema.org/draft-06/schema#",

  "definitions": {
    "datetime": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
  }
}

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "properties": {
    "active": {"type": "boolean"},
    "created_at": { "$ref": "../base/definitions.schema.json#/definitions/datetime" },
    "name": { "$ref": "../base/base/definitions.schema.json#/definitions/name" },
    "updated_at": { "$ref": "../base/definitions.schema.json#/definitions/datetime" }
  },
  "required": ["name"],
  "type": "object"
}

Directory structure:

api
-- base
  -- definitions.schema.json
-- country
  -- country.schema.json

I have tried several combinations by using an absolute path, a file url and several other combinations of the path. Not sure what's going on.

Schema validator: [email protected]

esp esp · Accepted Answer · 2017-09-24T19:19:25

You need to add schemas using "addSchema" method. $ref is resolved relative to "id" attribute ("$id" in draft-06), ajv doesn't (and can't) use file paths.

EDIT: added $ref section to docs.

How to use definitions from external files in JSON Schema?

1 Answers