DocumentationQuality-schema.json

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "../Documentation/Implementation/data_model/Json/",
    "title": "DocumentationQuality",
    "description": "DocumentationQuality schema",
    "dataTypes": null,
    "type": "object",
    "properties": {
        "description": {
            "type": "string",
            "description": "General description of documentation and quality methods applied to data"
        },
        "dataOrganization": {
            "type": "array",
            "items": {
                "type": "object",
                "$comment": "class=ResourceReference",
                "properties": {
                    "dbid": {
                        "type": "number"
                    }
                },
                "required": [
                    "dbid"
                ]
            },
            "description": "Description of the organisation of the documents and data generated during the project"
        },
        "metadataStandard": {
            "type": "array",
            "items": {
                "type": "object",
                "$comment": "class=MetadataStandard",
                "properties": {
                    "dbid": {
                        "type": "number"
                    }
                },
                "required": [
                    "dbid"
                ]
            },
            "description": "Metadata standard(s) or data used"
        },
        "metadataLanguage": {
            "type": "string",
            "length": "3",
            "description": "Metadata language code"
        },
        "documentationSoftware": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "Chosen tool for capturing metadata and documentation"
        },
        "contributor": {
            "type": "array",
            "items": {
                "type": "object",
                "$comment": "class=Contributor",
                "properties": {
                    "dbid": {
                        "type": "number"
                    }
                },
                "required": [
                    "dbid"
                ]
            },
            "description": "Person(s) involved in data documentation, metadata generation and/or data quality assurance"
        },
        "cost": {
            "type": "array",
            "items": {
                "type": "object",
                "$comment": "class=Cost",
                "properties": {
                    "dbid": {
                        "type": "number"
                    }
                },
                "required": [
                    "dbid"
                ]
            },
            "description": "Possible costs in terms of human resources or acquisition of software for data documentation"
        }
    },
    "required": [
        "description",
        "dataOrganization",
        "metadataStandard",
        "metadataLanguage",
        "contributor"
    ]
}