Updated
Sep 22, 2020, 12:04:12 PM

{
    "$schema": "http://json-schema.org/schema#",
    "additionalProperties": false,
    "id": "https://github.com/CIRCL/open-data-security/blob/master/schema.json",
    "properties": {
        "description": {
            "$comment": "an exhaustive description of the dataset including methods of collection, extraction or analysis",
            "type": "string"
        },
        "frequency": {
            "$comment": "frequency of the dataset generation which MUST be expressed in yearly, monthly, daily, hourly",
            "type": "string"
        },
        "human-validated": {
            "$comment": "human-validated describes if the dataset has been manually validated",
            "type": "boolean"
        },
        "license": {
            "$comment": "license MUST be expressed in SPDX format to describe under which license the dataset is distributed",
            "type": "string"
        },
        "machine-validated": {
            "$comment": "machine-validated describes if the dataset has been automatically validated",
            "type": "boolean"
        },
        "producer": {
            "$comment": "producer MUST be expressed as an URI to reference the original producer of the dataset",
            "type": "string"
        },
        "source": {
            "type": "array",
            "uniqueItems": true
        },
        "subtitle": {
            "$comment": "an extended title of the dataset",
            "type": "string"
        },
        "tags": {
            "$comment": "tag SHOULD come from a MISP taxonomy namespace",
            "type": "array",
            "uniqueItems": true
        },
        "time-precision": {
            "$comment": "time-precision MUST be expressed in years, months, days, hours, minutes or seconds to describe the precision of the time expressed",
            "type": "string"
        },
        "title": {
            "$comment": "a comprehensive and concise title of the dataset",
            "type": "string"
        },
        "version": {
            "type": "integer"
        }
    },
    "required": [
        "title",
        "license"
    ],
    "title": "Validator for open-data-security format",
    "type": "object"
}