benchmarking-data-model/json-schemas/0.4.x/tool.json at master · redmitry/benchmarking-data-model · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
{
	"id": "https://www.elixir-europe.org/excelerate/WP2/json-schemas/0.4/Tool",
	"$schema": "http://json-schema.org/draft-04/hyper-schema#",
	"title": "Tool concept (ELIXIR-EXCELERATE WP2 Benchmarking schemas)",
	"type": "object",
	"properties": {
		"_id": {
			"title": "The unique id of the tool, according to the rules",
			"type": "string",
			"pattern": "^OEBT[0-9]{3}[A-Z0-9]{7}$"
		},
		"_schema": {
			"title": "The JSON schema absolute URI. It must match the value of 'id' in the JSON schema",
			"type": "string",
			"format": "uri",
			"enum": [ "https://www.elixir-europe.org/excelerate/WP2/json-schemas/0.4/Tool" ]
		},
		"registry_tool_id": {
			"title": "The unique id of the tool (in bio.tools, bioconda, biocontainers, OpenEBench, etc...), in CURIE format",
			"type": "string",
			"format": "uri"
		},
		"name": {
			"title": "Short tool name",
			"minLength": 1,
			"type": "string"
		},
		"description": {
			"title": "Long tool name or description",
			"type": "string"
		},
		"is_automated": {
			"title": "Can this tool be automatically invoked?",
			"type": "boolean"
		},
		"tool_contact_id": {
			"title": "The tool's contact id(s), i.e. the creators",
			"type": "array",
			"minLength": 1,
			"items": {
				"type": "string",
				"foreign_keys": [
					{
						"schema_id": "Contact",
						"members": [ "." ]
					}
				],
				"minLength": 1
			}
		},
		"status": {
			"title": "Current tool status",
			"type": "string",
			"enum": ["unknown","online","offline","unmaintained"],
			"minLength": 1
		},
		"activation": {
			"title": "Activation by the benchmarking community",
			"type": "string",
			"format": "date-time"
		},
		"deactivation": {
			"title": "Deactivation by the benchmarking community",
			"type": "string",
			"format": "date-time"
		},
		"references": {
			"title": "The tool's reference id(s)",
			"type": "array",
			"minLength": 1,
			"items": {
				"type": "string",
				"foreign_keys": [
					{
						"schema_id": "Reference",
						"members": [ "." ]
					}
				],
				"minLength": 1
			}
		},
		"tool_access": {
			"title": "Methods to access the tool",
			"type": "array",
			"minLength": 1,
			"items": {
				"type": "object",
				"properties": {
					"tool_access_type": {
						"title": "The tool access type",
						"type": "string",
						"enum": [ "command-line", "REST/OpenAPI", "SOAP/WSDL", "Web", "other" ],
						"minLength": 1
					},
					"link": {
						"title": "The base link to the access point (when it is not a local algorithm)",
						"type": "string",
						"format": "uri"
					},
					"techdocs": {
						"title": "Optional technical documentation of the tool access",
						"type": "array",
						"items": {
							"type": "object",
							"properties": {
								"uri": {
									"title": "The URI of the technical documentation",
									"type": "string",
									"format": "uri"
								},
								"label": {
									"title": "The type of URI (WSDL, WADL, OpenAPI/Swagger, Source code, Miscellaneous documentation)",
									"type": "string",
									"enum": ["WSDL","WADL","OpenAPI","API","source","doc"]
								}
							},
							"additionalProperties": false,
							"required": [
								"uri",
								"label"
							]
						}
					}
				},
				"additionalProperties": true,
				"required": [
					"tool_access_type_id"
				]
			}
		}
	},
	"additionalProperties": true,
	"required": ["_id","_schema","name","is_automated","community_id","tool_contact_id","status","tool_access"],
	"primary_key": ["_id"],
	"dependencies": {}
}