datahelix.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://scottlogic.com/datahelix.json",
  "title": "The Scott Logic DataHelix Profile Schema",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "fields"
  ],
  "properties": {
    "additionalProperties": false,
    "description": {
      "title": "A description of what data the profile is modelling",
      "type": "string"
    },
    "fields": {
      "title": "The fields that data will be produced for. Field names must begin with an alphabetic character.",
      "type": "array",
      "minItems": 1,
      "uniqueItems": true,
      "additionalItems": false,
      "items": {
        "$ref": "#/definitions/field"
      }
    },
    "constraints": {
      "title": "The constraints on the data to be output",
      "type": "array",
      "additionalItems": false,
      "items": {
        "$ref": "#/definitions/constraint"
      }
    }
  },
  "definitions": {
    "dataType": {
      "oneOf": [
        {
          "$ref": "#/definitions/datetime"
        },
        {
          "$ref": "#/definitions/time"
        },
        {
          "$ref": "#/definitions/string"
        },
        {
          "$ref": "#/definitions/numeric"
        },
        {
          "$ref": "#/definitions/boolean"
        }
      ]
    },
    "datetime": {
      "title": "an ISO 8610 compatible string denoting a datetime or date",
      "type": "string",
      "default": "2000-01-01T09:00:00.000",
      "anyOf": [
        {
          "pattern": "^(?!0000)\\d{4}-([0]\\d|[1][0-2])-([0-2]\\d|3[01])T[0-2]\\d:[0-5]\\d(?::[0-5]\\d(?:\\.\\d+Z?)?)?"
        },
        {
          "pattern": "^(?!0000)\\d{4}-([0]\\d|[1][0-2])-([0-2]\\d|3[01])"
        },
        {
          "enum": [
            "now"
          ]
        }
      ]
    },
    "time": {
      "title": "an ISO 8601 compatible string denoting a time",
      "type": "string",
      "default": "00:00:00",
      "anyOf": [
        {
          "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9][.][0-9]{3}$"
        },
        {
          "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$"
        },
        {
          "enum": [
            "now"
          ]
        }
      ]
    },
    "numeric": {
      "type": "number",
      "minimum": -1e20,
      "maximum": 1e20,
      "default": 0
    },
    "boolean": {
      "type": "boolean",
      "default": false
    },
    "granularity": {
      "value": {
        "enum": [
          1,
          1e-1,
          1e-2,
          1e-3,
          1e-4,
          1e-5,
          1e-6,
          1e-7,
          1e-8,
          1e-9,
          1e-10,
          1e-11,
          1e-12,
          1e-13,
          1e-14,
          1e-15,
          1e-16,
          1e-17,
          1e-18,
          1e-19,
          1e-20,
          "millis",
          "seconds",
          "minutes",
          "hours",
          "days",
          "months",
          "years",
          "working days"
        ]
      }
    },
    "integer": {
      "$ref": "#/definitions/numeric",
      "multipleOf": 1
    },
    "string": {
      "type": "string",
      "maxLength": 1000,
      "default": "string",
      "not": {
        "anyOf": [
          {
            "$ref": "#/definitions/datetime"
          },
          {
            "$ref": "#/definitions/time"
          }
        ]
      }
    },
    "faker": {
      "type": "string",
      "pattern": "^faker.(w+.?)((w+).)*(w+)"
    },
    "field": {
      "title": "The field definitions of a field to generate data for",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "name",
        "type"
      ],
      "default": {
        "name": "fieldName",
        "type": "string",
        "formatting": "",
        "unique": false,
        "nullable": true
      },
      "properties": {
        "name": {
          "type": "string"
        },
        "type": {
          "oneOf" : [
            {
              "type": "string",
              "enum": [
                "decimal",
                "integer",
                "string",
                "datetime",
                "date",
                "time",
                "ISIN",
                "SEDOL",
                "CUSIP",
                "RIC",
                "firstname",
                "lastname",
                "fullname"
              ]
            },
            {
              "type": "string",
              "pattern": "^faker\\.(\\w+.?)((\\w+).)*(\\w+)"
            }
          ]
        },
        "formatting": {
          "type": "string"
        },
        "unique": {
          "type": "boolean"
        },
        "nullable": {
          "type": "boolean"
        },
        "generator": {
          "type": "string"
        }
      }
    },
    "constraint": {
      "oneOf": [
        {
          "$ref": "#/definitions/generatorConstraint"
        },
        {
          "$ref": "#/definitions/equalToConstraint"
        },
        {
          "$ref": "#/definitions/equalToFieldConstraint"
        },
        {
          "$ref": "#/definitions/granularToConstraint"
        },
        {
          "$ref": "#/definitions/matchingRegexConstraint"
        },
        {
          "$ref": "#/definitions/containingRegexConstraint"
        },
        {
          "$ref": "#/definitions/ofLengthConstraint"
        },
        {
          "$ref": "#/definitions/longerThanConstraint"
        },
        {
          "$ref": "#/definitions/shorterThanConstraint"
        },
        {
          "$ref": "#/definitions/greaterThanConstraint"
        },
        {
          "$ref": "#/definitions/greaterThanFieldConstraint"
        },
        {
          "$ref": "#/definitions/greaterThanOrEqualToConstraint"
        },
        {
          "$ref": "#/definitions/greaterThanOrEqualToFieldConstraint"
        },
        {
          "$ref": "#/definitions/lessThanConstraint"
        },
        {
          "$ref": "#/definitions/lessThanFieldConstraint"
        },
        {
          "$ref": "#/definitions/lessThanOrEqualToConstraint"
        },
        {
          "$ref": "#/definitions/lessThanOrEqualToFieldConstraint"
        },
        {
          "$ref": "#/definitions/afterConstraint"
        },
        {
          "$ref": "#/definitions/afterFieldConstraint"
        },
        {
          "$ref": "#/definitions/afterOrAtConstraint"
        },
        {
          "$ref": "#/definitions/afterOrAtFieldConstraint"
        },
        {
          "$ref": "#/definitions/beforeConstraint"
        },
        {
          "$ref": "#/definitions/beforeFieldConstraint"
        },
        {
          "$ref": "#/definitions/beforeOrAtConstraint"
        },
        {
          "$ref": "#/definitions/beforeOrAtFieldConstraint"
        },
        {
          "$ref": "#/definitions/anyOfConstraint"
        },
        {
          "$ref": "#/definitions/allOfConstraint"
        },
        {
          "$ref": "#/definitions/nullConstraint"
        },
        {
          "$ref": "#/definitions/inSetConstraint"
        },
        {
          "$ref": "#/definitions/inMapConstraint"
        },
        {
          "$ref": "#/definitions/notConstraint"
        },
        {
          "$ref": "#/definitions/ifConstraint"
        }
      ]
    },
    "generatorConstraint": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "field",
        "generator"
      ],
      "properties": {
        "field": {
          "type": "string"
        },
        "generator": {
          "$ref": "#/definitions/string"
        }
      }
    },
    "equalToConstraint": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "field",
        "equalTo"
      ],
      "properties": {
        "field": {
          "type": "string"
        },
        "equalTo": {
          "$ref": "#/definitions/dataType"
        }
      }
    },
    "equalToFieldConstraint": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "field",
        "equalToField"
      ],
      "properties": {
        "field": {
          "type": "string"
        },
        "equalToField": {
          "type": "string"
        },
        "offset": {
          "$ref": "#/definitions/integer"
        },
        "offsetUnit": {
          "$ref": "#/definitions/granularity"
        }
      }
    },
    "granularToConstraint": {
      "type": "object",
      "required": [
        "field",
        "granularTo"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "granularTo": {
          "$ref": "#/definitions/granularity"
        }
      }
    },
    "matchingRegexConstraint": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "field",
        "matchingRegex"
      ],
      "properties": {
        "field": {
          "type": "string"
        },
        "matchingRegex": {
          "type": "string",
          "default": ".*"
        }
      }
    },
    "containingRegexConstraint": {
      "type": "object",
      "required": [
        "field",
        "containingRegex"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "containingRegex": {
          "type": "string",
          "default": ".*"
        }
      }
    },
    "ofLengthConstraint": {
      "type": "object",
      "required": [
        "field",
        "ofLength"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "ofLength": {
          "$ref": "#/definitions/integer",
          "minimum": 0,
          "maximum": 1000
        }
      }
    },
    "longerThanConstraint": {
      "type": "object",
      "required": [
        "field",
        "longerThan"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "longerThan": {
          "$ref": "#/definitions/integer",
          "minimum": -1,
          "maximum": 999
        }
      }
    },
    "shorterThanConstraint": {
      "type": "object",
      "required": [
        "field",
        "shorterThan"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "shorterThan": {
          "$ref": "#/definitions/integer",
          "minimum": 1,
          "maximum": 1001
        }
      }
    },
    "greaterThanConstraint": {
      "type": "object",
      "required": [
        "field",
        "greaterThan"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "greaterThan": {
          "$ref": "#/definitions/numeric"
        }
      }
    },
    "greaterThanFieldConstraint": {
      "type": "object",
      "required": [
        "field",
        "greaterThanField"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "greaterThanField": {
          "type": "string"
        },
        "offset": {
          "$ref": "#/definitions/integer"
        },
        "offsetUnit": {
          "$ref": "#/definitions/granularity"
        }
      }
    },
    "greaterThanOrEqualToConstraint": {
      "type": "object",
      "required": [
        "field",
        "greaterThanOrEqualTo"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "greaterThanOrEqualTo": {
          "$ref": "#/definitions/numeric"
        }
      }
    },
    "greaterThanOrEqualToFieldConstraint": {
      "type": "object",
      "required": [
        "field",
        "greaterThanOrEqualFieldTo"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "greaterThanOrEqualFieldTo": {
          "type": "string"
        },
        "offset": {
          "$ref": "#/definitions/integer"
        },
        "offsetUnit": {
          "$ref": "#/definitions/granularity"
        }
      }
    },
    "lessThanConstraint": {
      "type": "object",
      "required": [
        "field",
        "lessThan"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "lessThan": {
          "$ref": "#/definitions/numeric"
        }
      }
    },
    "lessThanFieldConstraint": {
      "type": "object",
      "required": [
        "field",
        "lessThanField"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "lessThanField": {
          "type": "string"
        },
        "offset": {
          "$ref": "#/definitions/integer"
        },
        "offsetUnit": {
          "$ref": "#/definitions/granularity"
        }
      }
    },
    "lessThanOrEqualToConstraint": {
      "type": "object",
      "required": [
        "field",
        "lessThanOrEqualTo"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "lessThanOrEqualTo": {
          "$ref": "#/definitions/numeric"
        }
      }
    },
    "lessThanOrEqualToFieldConstraint": {
      "type": "object",
      "required": [
        "field",
        "lessThanOrEqualToField"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "lessThanOrEqualToField": {
          "type": "string"
        },
        "offset": {
          "$ref": "#/definitions/integer"
        },
        "offsetUnit": {
          "$ref": "#/definitions/granularity"
        }
      }
    },
    "afterConstraint": {
      "type": "object",
      "required": [
        "field",
        "after"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "after":
        {
          "anyOf": [
            {
              "$ref": "#/definitions/time"

            },
            {
              "$ref": "#/definitions/datetime"
            }
          ]
        }
      }
    },
    "afterFieldConstraint": {
      "type": "object",
      "required": [
        "field",
        "afterField"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "afterField": {
          "type": "string"
        },
        "offset": {
          "$ref": "#/definitions/integer"
        },
        "offsetUnit": {
          "$ref": "#/definitions/granularity"
        }
      }
    },
    "afterOrAtConstraint": {
      "type": "object",
      "required": [
        "field",
        "afterOrAt"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "afterOrAt": {
          "anyOf": [
            {
              "$ref": "#/definitions/time"

            },
            {
              "$ref": "#/definitions/datetime"
            }
          ]
        }
      }
    },
    "afterOrAtFieldConstraint": {
      "type": "object",
      "required": [
        "field",
        "afterOrAtField"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "afterOrAtField": {
          "type": "string"
        },
        "offset": {
          "$ref": "#/definitions/integer"
        },
        "offsetUnit": {
          "$ref": "#/definitions/granularity"
        }
      }
    },
    "beforeConstraint": {
      "type": "object",
      "required": [
        "field",
        "before"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "before": {
          "anyOf": [
            {
              "$ref": "#/definitions/time"

            },
            {
              "$ref": "#/definitions/datetime"
            }
          ]
        }
      }
    },
    "beforeFieldConstraint": {
      "type": "object",
      "required": [
        "field",
        "beforeField"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "beforeField": {
          "type": "string"
        },
        "offset": {
          "$ref": "#/definitions/integer"
        },
        "offsetUnit": {
          "$ref": "#/definitions/granularity"
        }
      }
    },
    "beforeOrAtConstraint": {
      "type": "object",
      "required": [
        "field",
        "beforeOrAt"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "beforeOrAt": {
          "anyOf": [
            {
              "$ref": "#/definitions/time"

            },
            {
              "$ref": "#/definitions/datetime"
            }
          ]
        }
      }
    },
    "beforeOrAtFieldConstraint": {
      "type": "object",
      "required": [
        "field",
        "beforeOrAtField"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "beforeOrAtField": {
          "type": "string"
        },
        "offset": {
          "$ref": "#/definitions/integer"
        },
        "offsetUnit": {
          "$ref": "#/definitions/granularity"
        }
      }
    },
    "notConstraint": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "not"
      ],
      "properties": {
        "not": {
          "$ref": "#/definitions/constraint"
        }
      }
    },
    "anyOfConstraint": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "anyOf"
      ],
      "properties": {
        "anyOf": {
          "type": "array",
          "minItems": 2,
          "items": {
            "$ref": "#/definitions/constraint"
          }
        }
      }
    },
    "allOfConstraint": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "allOf"
      ],
      "properties": {
        "allOf": {
          "type": "array",
          "minItems": 2,
          "items": {
            "$ref": "#/definitions/constraint"
          }
        }
      }
    },
    "ifConstraint": {
      "type": "object",
      "required": [
        "if",
        "then"
      ],
      "additionalProperties": false,
      "properties": {
        "if": {
          "$ref": "#/definitions/constraint"
        },
        "then": {
          "$ref": "#/definitions/constraint"
        },
        "else": {
          "$ref": "#/definitions/constraint"
        }
      }
    },
    "nullConstraint": {
      "type": "object",
      "required": [
        "field",
        "isNull"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "isNull": {
          "type": "boolean"
        }
      }
    },
    "inSetConstraint": {
      "type": "object",
      "required": [
        "field",
        "inSet"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "inSet": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "array",
              "items": {
                "oneOf": [
                  {
                    "$ref": "#/definitions/datetime"
                  },
                  {
                    "$ref": "#/definitions/time"
                  },
                  {
                    "$ref": "#/definitions/numeric"
                  },
                  {
                    "$ref": "#/definitions/string"
                  }
                ]
              }
            }
          ]
        }
      }
    },
    "inMapConstraint": {
      "type": "object",
      "required": [
        "field",
        "file",
        "key"
      ],
      "additionalProperties": false,
      "properties": {
        "field": {
          "type": "string"
        },
        "file": {
          "type": "string"
        },
        "key": {
          "type": "string"
        }
      }
    }
  }
}