project.json

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$id": "https://github.com/cdsig/CDSIG-Schema/blob/main/project.json",
  "title": "Project-level metadata",
  "description": "Project-level metadata is metadata that describes the project. A project could be a wider organisational unit of studies. For example, there may be different substudies within a project.",
  "type": "object",
  "properties": {
    "name": {
      "description": "Informative or internal name of the project",
      "example": "ACHM2019_Project",
      "type": "string"
    },
    "uuid": {
      "description": "This is a uniqe MD5 hash generated from the `name` field",
      "example": "c815b5d426655176b74852f07dc7ef02",
      "type": "string"
    },
    "funding_sources": {
      "description": "Any funding sources supporting the project. If the funding number is available, it should be given",
      "example": ["Wellcome Trust 204686/Z/16/Z"],
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "string"
      }
    },
    "description": {
      "description": "Short narrative description of the project. This could include any further information on the project and the context in which it was completed",
      "example": "",
      "type": "string"
    },
    "keywords": {
      "description": "Key words describing the projects.",
      "example": ["actigraphy", "congenital achromatopsia", "circadian"],
      "type": "array",
      "minItems": 3,
      "items": {
        "type": "string"
      }
    },
    "contributors": {
      "type": "array",
      "items": {
        "$ref": "https://raw.githubusercontent.com/cdsig/CDSIG-Schema/main/person.json"
      }
    },
    "project_status": {
      "description": "Status of the project (i.e. if it is still running)",
      "type": "object",
      "properties": {
        "period": {
          "description": "Time period during which the project took place",
          "type": "object",
          "properties": {
            "start_date_time": {
              "description": "Start date-time for the project",
              "type": "string",
              "format": "date-time"
            },
            "ongoing": {
              "description": "Indicate if the project is still ongoing (true) or completed (false)",
              "type": "boolean"
            }
          },
          "if": {
            "properties": { "ongoing": { "const": true } }
          },
          "then": {
            "properties": {
              "stop_date_time": {
                "description": "Stop date-time for the project",
                "type": "string",
                "format": "date-time"
              }
            }
          }
        }
      },
      "required": ["period"]
    }
  },
  "required": ["name", "uuid", "description", "keywords", "contributors", "project_status"]
}