How can I use references

[tobiju]

How do I use the option references in combination with "$ref": "my.schema"?

[morganney]

Create a separate file somewhere that contains a list of schemas you want to reference. For example, myDefinitions.json that might look like this:

[
  {
    "id": "someThing",
    "type": "string",
    "enum": ["foo", "bar"]
  }
]

Then in the grunt config for the task target do this:

grunt.initConfig({
  jsonschema_faker: {
    target: {
      src: ['anotherThingSchema.json'],
      dest: '...',
      options: {
        references: ['path/to/myDefinitions.json'] // this value is passed to grunt.file.expand
      }
    }
  }
})

Now you can reference the schemas defined in myDefinitions.json by their id in anotherThingSchema.json like this {"$ref": "someThing"}.