analysis_schema.json

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "analysis_schema",
    "description": "This is UCSC Genomics Core's schema for an analysis workflow's metadata record. It is based on the schema defined in metadata_schema.json.",
    "definitions": {
        "time_stamp": {
            "description": "ISO 8601 / RFC 3339",
            "type": "string",
            "format": "date-time"
        },
        "schema_version": {
            "description": "The version of this schema is ...",
            "type": "string",
            "pattern": "^0.0.3$"
        },
        "uuid": {
            "description": "uuid with all lower case or all upper case characters",
            "type": "string",
            "oneOf": [
                {
                    "description": "lower case",
                    "pattern": "^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"
                }, {
                    "description": "upper case",
                    "pattern": "^[0-9A-F]{8}-([0-9A-F]{4}-){3}[0-9A-F]{12}$"
                }
            ]
        }
    },
    "type": "object",
    "required": ["parent_uuids", "timestamp", "analysis_type", "bundle_uuid", "workflow_name", "workflow_version", "workflow_outputs"],
    "properties": {
        "analysis_type": {
            "description": "The analysis type needs to be tightly controlled because it is used in the metadata merging script to assign flags.",
            "enum": ["sequence_upload", "alignment", "rna_seq_quantification", "germline_variant_calling", "somatic_variant_calling", "immuno_target_pipelines"]
        },
        "parent_uuids": {
            "description": "parent UUIDs for this workflow",
            "type": "array",
            "items": {
                "$ref": "#/definitions/uuid"
            }
        },
        "bundle_uuid": {
            "$ref": "#/definitions/uuid"
        },
        "workflow_name": {
            "type": "string"
        },
        "workflow_version": {
            "type": "string"
        },
        "timestamp": {
            "description": "We want this time stamp in detached analysis data, but not required when uploading via upload tool.",
            "$ref": "#/definitions/time_stamp"
        },
        "workflow_outputs": {
            "type": "array",
            "items": {
                "type": "object",
                "required": ["file_path", "file_type"],
                "properties": {
                    "file_path": {
                        "type": "string"
                    },
                    "file_type": {
                        "type": "string"
                    },
                    "file_uuid": {
                        "$ref": "#/definitions/uuid"
                    }
                }
            }
        }
    }
}