Skip to content

Commit

Permalink
v4 metadata schema ready for release. All $ref tags updated to raw gi…
Browse files Browse the repository at this point in the history 
…thub v4 tag URL
  • Loading branch information
@daniwelter
daniwelter committed Nov 21, 2017
1 parent 80eb40a commit fc98079
Show file tree
Hide file tree
Showing 30 changed files with 825 additions and 778 deletions.
304 changes: 152 additions & 152 deletions json_schema/analysis.json
View file
Original file line number Diff line number Diff line change
@@ -1,155 +1,155 @@
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"additionalProperties" : true,
"properties" : {
"tasks" : {
"description" : "Descriptions of tasks in the workflow.",
"type" : "array",
"items" : {
"type" : {
"$ref" : "analysis.json#/definitions/task"
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"properties": {
"tasks": {
"description": "Descriptions of tasks in the workflow.",
"type": "array",
"items": {
"type": {
"$ref": "https://raw.githubusercontent.com/HumanCellAtlas/metadata-schema/4.0/json_schema/analysis.json#/definitions/task"
}
}
}
},
"analysis_id" : {
"description" : "A unique ID for this analysis.",
"type" : "number"
},
"name": {
"description": "A short, descriptive name for the analysis that need not be unique.",
"type": "string"
},
"description": {
"description": "A general description of the analysis.",
"type": "string"
},
"computational_method" : {
"description" : "A URI to a versioned workflow and versioned execution environment in a GA4GH-compliant repository.",
"type" : "uri"
},
"outputs" : {
"items" : {
"type" : {
"$ref" : "analysis.json#/definitions/file"
}
},
"description" : "Output generated by the pipeline run.",
"type" : "array"
},
"input_bundles" : {
"items" : {
"type" : "uri"
},
"description" : "The input bundles used in this analysis run.",
"type" : "array"
},
"timestamp_stop_utc" : {
"type" : "date-time",
"description" : "Terminal stop time of the full pipeline."
},
"metadata_schema" : {
"description" : "The version of the metadata schemas used for the json files.",
"type" : "string"
},
"timestamp_start_utc" : {
"description" : "Initial start time of the full pipeline.",
"type" : "date-time"
},
"inputs" : {
"items" : {
"type" : {
"$ref" : "analysis.json#/definitions/parameter"
}
},
"type" : "array",
"description" : "Input parameters used in the pipeline run, these can be files or string values (settings)."
},
"analysis_run_type" : {
"enum" : [
"run",
"copy-forward"
],
"description" : "Indicator of whether the analysis actually ran or was just copied forward as an optimization.",
"type" : "string"
},
"reference_bundle" : {
"description" : "Bundle containing the reference used in running the pipeline.",
"type" : "uri"
},
"core": {
},
"analysis_id": {
"description": "A unique ID for this analysis.",
"type": "number"
},
"name": {
"description": "A short, descriptive name for the analysis that need not be unique.",
"type": "string"
},
"description": {
"description": "A general description of the analysis.",
"type": "string"
},
"computational_method": {
"description": "A URI to a versioned workflow and versioned execution environment in a GA4GH-compliant repository.",
"type": "uri"
},
"outputs": {
"items": {
"type": {
"$ref": "https://raw.githubusercontent.com/HumanCellAtlas/metadata-schema/4.0/json_schema/analysis.json#/definitions/file"
}
},
"description": "Output generated by the pipeline run.",
"type": "array"
},
"input_bundles": {
"items": {
"type": "uri"
},
"description": "The input bundles used in this analysis run.",
"type": "array"
},
"timestamp_stop_utc": {
"type": "date-time",
"description": "Terminal stop time of the full pipeline."
},
"metadata_schema": {
"description": "The version of the metadata schemas used for the json files.",
"type": "string"
},
"timestamp_start_utc": {
"description": "Initial start time of the full pipeline.",
"type": "date-time"
},
"inputs": {
"items": {
"type": {
"$ref": "https://raw.githubusercontent.com/HumanCellAtlas/metadata-schema/4.0/json_schema/analysis.json#/definitions/parameter"
}
},
"type": "array",
"description": "Input parameters used in the pipeline run, these can be files or string values (settings)."
},
"analysis_run_type": {
"enum": [
"run",
"copy-forward"
],
"description": "Indicator of whether the analysis actually ran or was just copied forward as an optimization.",
"type": "string"
},
"reference_bundle": {
"description": "Bundle containing the reference used in running the pipeline.",
"type": "uri"
},
"core": {
"description": "Type and schema for this object.",
"$ref": "core.json"
}
},
"type" : "object",
"definitions" : {
"file" : {
"additionalProperties" : false,
"required" : [
"checksum",
"file_path",
"format"
],
"properties" : {
"format" : "string",
"file_path" : "uri",
"checksum" : "string"
},
"type" : "object"
},
"task" : {
"properties" : {
"start_time" : "date-time",
"stop_time" : "date-time",
"name" : "string",
"log_err" : "uri",
"log_out" : "uri",
"disk_size" : "string",
"docker_image" : "string",
"cpus" : "int",
"memory" : "string",
"zone" : "string"
},
"required" : [
"name",
"start_time",
"stop_time",
"log",
"disk_size",
"docker_image",
"cpus",
"memory",
"zone"
],
"additionalProperties" : false,
"type" : "object"
},
"parameter" : {
"additionalProperties" : false,
"required" : [
"name",
"value"
],
"properties" : {
"checksum" : "string",
"value" : "string",
"name" : "string"
},
"type" : "object"
}
},
"title" : "analysis",
"required" : [
"timestamp_start_utc",
"timestamp_stop_utc",
"computational_method",
"input_bundles",
"reference_bundle",
"analysis_id",
"analysis_run_type",
"metadata_schema",
"tasks",
"inputs",
"outputs"
]
}
"$ref": "https://raw.githubusercontent.com/HumanCellAtlas/metadata-schema/4.0/json_schema/core.json"
}
},
"type": "object",
"definitions": {
"file": {
"additionalProperties": false,
"required": [
"checksum",
"file_path",
"format"
],
"properties": {
"format": "string",
"file_path": "uri",
"checksum": "string"
},
"type": "object"
},
"task": {
"properties": {
"start_time": "date-time",
"stop_time": "date-time",
"name": "string",
"log_err": "uri",
"log_out": "uri",
"disk_size": "string",
"docker_image": "string",
"cpus": "int",
"memory": "string",
"zone": "string"
},
"required": [
"name",
"start_time",
"stop_time",
"log",
"disk_size",
"docker_image",
"cpus",
"memory",
"zone"
],
"additionalProperties": false,
"type": "object"
},
"parameter": {
"additionalProperties": false,
"required": [
"name",
"value"
],
"properties": {
"checksum": "string",
"value": "string",
"name": "string"
},
"type": "object"
}
},
"title": "analysis",
"required": [
"timestamp_start_utc",
"timestamp_stop_utc",
"computational_method",
"input_bundles",
"reference_bundle",
"analysis_id",
"analysis_run_type",
"metadata_schema",
"tasks",
"inputs",
"outputs"
]
}
41 changes: 21 additions & 20 deletions json_schema/assay.json
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {},
"additionalProperties": false,
"definitions": {},
"description": "An assay contains information relevant to how a sample (in vitro) was converted into digital information (in silico).",
"properties": {
"properties": {
"core": {
"description": "Type and schema for this object.",
"$ref": "core.json"
"description": "Type and schema for this object.",
"$ref": "https://raw.githubusercontent.com/HumanCellAtlas/metadata-schema/4.0/json_schema/core.json"
},
"assay_id": {
"description": "A unique ID for this assay.",
Expand All @@ -20,26 +20,27 @@
"description": "A general description of the assay.",
"type": "string"
},
"imaging": {
"description": "Information on image based RNA quantification assays",
"$ref": "imaging.json"
"imaging": {
"description": "Information on image based RNA quantification assays",
"$ref": "https://raw.githubusercontent.com/HumanCellAtlas/metadata-schema/4.0/json_schema/imaging.json"
},
"rna": {
"description": "Information about how RNA was converted to cDNA.",
"$ref": "rna.json"
},
"description": "Information about how RNA was converted to cDNA.",
"$ref": "https://raw.githubusercontent.com/HumanCellAtlas/metadata-schema/4.0/json_schema/rna.json"
},
"seq": {
"description": "Information about how a cDNA sample was sequenced.",
"$ref": "seq.json"
},
"description": "Information about how a cDNA sample was sequenced.",
"$ref": "https://raw.githubusercontent.com/HumanCellAtlas/metadata-schema/4.0/json_schema/seq.json"
},
"single_cell": {
"description": "Information on single-cell aspects of an assay.",
"$ref": "single_cell.json"
"description": "Information on single-cell aspects of an assay.",
"$ref": "https://raw.githubusercontent.com/HumanCellAtlas/metadata-schema/4.0/json_schema/single_cell.json"
}
},
},
"required": [
"core", "assay_id"
"core",
"assay_id"
],
"title": "assay",
"title": "assay",
"type": "object"
}
}
Loading

0 comments on commit fc98079

Please sign in to comment.