Skip to content

Commit 5f7f4ac

Browse files
wshayeswshayes
committed
Added title and description metadata to fields and fixed some formatting issues
1 parent b60eb64 commit 5f7f4ac

1 file changed

Lines changed: 200 additions & 166 deletions

File tree

‎child-schemas/bel-json-graph.schema.json‎

Lines changed: 200 additions & 166 deletions
Original file line numberDiff line numberDiff line change
@@ -1,192 +1,226 @@
1-
}, {
2-
"$schema": "http://json-schema.org/draft-04/schema",
3-
"oneOf": [{
4-
"type": "object",
5-
"properties": {
6-
"graph": {
7-
"$ref": "#/definitions/graph"
8-
}
1+
{
2+
"$schema": "http://json-schema.org/draft-04/schema",
3+
"oneOf": [{
4+
"type": "object",
5+
"properties": {
6+
"graph": {
7+
"$ref": "#/definitions/graph"
8+
}
9+
},
10+
"additionalProperties": false,
11+
"required": ["graph"]
12+
}, {
13+
"type": "object",
14+
"properties": {
15+
"label": {
16+
"type": "string",
17+
"title": "Graph Set Label",
18+
"description": "Graph Set label",
19+
"name": "graph_set_label"
20+
},
21+
"type": {
22+
"type": "string",
23+
"title": "Type of Graphs in Set",
24+
"description": "Graph types in graph set",
25+
"name": "graph_set_type"
26+
},
27+
"metadata": {
28+
"type": ["object", "null"],
29+
"title": "Graph Set Metadata",
30+
"description": "Graph set metadata",
31+
"name": "graph_set_metadata"
32+
},
33+
"graphs": {
34+
"type": "array",
35+
"items": {
36+
"$ref": "#/definitions/graph"
37+
}
38+
}
39+
},
40+
"additionalProperties": false
41+
}],
42+
"definitions": {
43+
"graph": {
44+
"type": "object",
45+
"additionalProperties": false,
46+
"properties": {
47+
"label": {
48+
"type": "string",
49+
"title": "Graph Label",
50+
"description": "Graph label",
51+
"name": "graph_label"
952
},
10-
"additionalProperties": false,
11-
"required": ["graph"]
12-
}, {
13-
"type": "object",
14-
"properties": {
15-
"id": {
16-
"type": "string",
17-
"title": "",
18-
"description": "",
19-
"name": ""
20-
},
21-
"label": {
22-
"type": "string",
23-
"title": "",
24-
"description": "",
25-
"name": ""
26-
},
27-
"type": {
28-
"type": "string",
29-
"title": "",
30-
"description": "",
31-
"name": ""
32-
},
33-
"metadata": {
34-
"type": ["object", "null"],
35-
"title": "",
36-
"description": "",
37-
"name": ""
38-
},
39-
"graphs": {
40-
"type": "array",
41-
"items": {
42-
"$ref": "#/definitions/graph"
43-
}
44-
}
53+
"directed": {
54+
"type": ["boolean", "null"],
55+
"description": "Directed or undirected graph",
56+
"default": true
4557
},
46-
"additionalProperties": false
47-
}],
48-
"definitions": {
49-
"graph": {
50-
"type": "object",
51-
"additionalProperties": false,
58+
"type": {
59+
"type": "string",
60+
"title": "Type of Graph",
61+
"description": "Graph type",
62+
"name": "graph_type"
63+
},
64+
"metadata": {
65+
"type": ["object", "null"],
66+
"additionalProperties": true,
5267
"properties": {
53-
"id": {
54-
"type": "string"
68+
"ncbi_tax_id": {
69+
"type": "integer",
70+
"title": "NCBI Taxonomy ID - ",
71+
"description": "NCBI Taxonomy ID - http://www.ncbi.nlm.nih.gov/taxonomy"
5572
},
56-
"label": {
57-
"type": "string"
73+
"species_common_name": {
74+
"type": "string",
75+
"title": "Species Common Name",
76+
"description": "Species common name, e.g. human, mouse, rat"
5877
},
59-
"directed": {
60-
"type": ["boolean", "null"],
61-
"default": true
62-
},
63-
"type": {
64-
"type": "string"
65-
},
66-
"metadata": {
67-
"type": ["object", "null"],
68-
"additionalProperties": true,
69-
"properties": {
70-
"ncbi_tax_id": {
71-
"type": "integer"
72-
},
73-
"species_common_name": {
74-
"type": "string"
75-
},
76-
"description": {
77-
"type": "string"
78-
},
79-
80-
}
81-
},
82-
"nodes": {
83-
"type": ["array", "null"],
84-
"items": {
85-
"type": "object",
86-
"additionalProperties": false,
78+
"description": {
79+
"type": "string",
80+
"title": "Graph description",
81+
"description": "Graph description"
82+
}
83+
}
84+
},
85+
"nodes": {
86+
"type": ["array", "null"],
87+
"items": {
88+
"type": "object",
89+
"additionalProperties": false,
90+
"properties": {
91+
"id": {
92+
"type": "string"
93+
},
94+
"label": {
95+
"type": "string"
96+
},
97+
"metadata": {
98+
"type": ["object", "null"],
99+
"additionalProperties": true,
87100
"properties": {
88-
"id": {
89-
"type": "string"
101+
102+
"x": {
103+
"type": "number",
104+
"title": "X coordinate",
105+
"description": "x coordinate of node location"
90106
},
91-
"label": {
92-
"type": "string"
107+
"y": {
108+
"type": "number",
109+
"title": "Y coordinate",
110+
"description": "y coordinate of node location"
93111
},
94-
"metadata": {
95-
"type": ["object", "null"],
96-
"additionalProperties": true,
97-
"properties": {
98-
"x_loc": {
99-
"type": "number"
100-
},
101-
"y_loc": {
102-
"type": "number"
103-
}
104-
}
112+
"z": {
113+
"type": "number",
114+
"title": "Z coordinate",
115+
"description": "z coordinate of node location - not needed for 2D visualizations"
105116
}
106-
},
107-
"required": ["id"]
117+
}
108118
}
109119
},
110-
"edges": {
111-
"type": ["array", "null"],
112-
"items": {
113-
"type": "object",
114-
"additionalProperties": false,
120+
"required": ["id"]
121+
}
122+
},
123+
"edges": {
124+
"type": ["array", "null"],
125+
"items": {
126+
"type": "object",
127+
"additionalProperties": false,
128+
"properties": {
129+
"id": {
130+
"type": "string"
131+
},
132+
"source": {
133+
"type": "string",
134+
"title": "Source Node",
135+
"description": "First node in edge triple"
136+
},
137+
"target": {
138+
"type": "string",
139+
"title": "Target Node",
140+
"description": "Second node in edge triple"
141+
},
142+
"relation": {
143+
"type": "string",
144+
"title": "Edge relationship",
145+
"description": "Relationship between nodes in edge - may be directed or undirected"
146+
},
147+
"directed": {
148+
"type": ["boolean", "null"],
149+
"default": true
150+
},
151+
"label": {
152+
"type": "string"
153+
},
154+
"metadata": {
155+
"type": ["object", "null"],
156+
"additionalProperties": true,
115157
"properties": {
116-
"id": {
117-
"type": "string"
118-
},
119-
"source": {
120-
"type": "string"
121-
},
122-
"target": {
123-
"type": "string"
124-
},
125-
"rel": {
126-
"type": "string"
127-
},
128-
"directed": {
129-
"type": ["boolean", "null"],
130-
"default": true
131-
},
132-
"label": {
133-
"type": "string"
134-
},
135-
"metadata": {
136-
"type": ["object", "null"],
137-
"additionalProperties": true,
138-
"properties": {
139-
"evidences": {
140-
"type": "array",
141-
"items": {
142-
"$ref": "#/definitions/evidence"
143-
}
144-
}
158+
"evidences": {
159+
"type": "array",
160+
"items": {
161+
"$ref": "#/definitions/evidence"
145162
}
146163
}
147-
},
148-
"required": ["id", "source", "target"]
164+
}
149165
}
150-
}
151-
},
152-
"required": ["id"]
166+
},
167+
"required": ["source", "target"]
168+
}
169+
}
170+
}
171+
},
172+
"evidence": {
173+
"type": "object",
174+
"properties": {
175+
"bel_statement": {
176+
"type": "string",
177+
"title": "BEL Statement",
178+
"description": "OpenBEL.org BEL Statement"
153179
},
154-
"evidence": {
180+
"citation": {
155181
"type": "object",
156182
"properties": {
157-
"bel_statement": {
158-
"type": "string"
183+
"reference_type": {
184+
"type": "string",
185+
"title": "Reference Type",
186+
"description": "The reference type of this citation."
159187
},
160-
"citation": {
161-
"type": "object",
162-
"properties": {
163-
"reference_type": {
164-
"type": "string"
165-
},
166-
"reference_id": {
167-
"type": "string"
168-
},
169-
"name": {
170-
"type": "string"
171-
},
172-
}
188+
"reference_id": {
189+
"type": "string",
190+
"title": "Reference ID",
191+
"description": "Identifier of the reference, e.g. PubMed ID"
173192
},
174-
"biological_context": {
175-
"type": "object",
176-
"additionalProperties": true,
177-
"properties": {
178-
"ncbi_tax_id": {
179-
"type": "integer"
180-
},
181-
"species_common_name": {
182-
"type": "string"
183-
}
184-
}
193+
"name": {
194+
"type": "string",
195+
"title": "Reference Name",
196+
"description": "Name or citation string for the citation."
197+
}
198+
},
199+
"title": "Citation for Edge Evidence",
200+
"description": "Reference to support the evidence presented for the Edge"
201+
},
202+
"biological_context": {
203+
"type": "object",
204+
"additionalProperties": true,
205+
"properties": {
206+
"ncbi_tax_id": {
207+
"type": "integer",
208+
"title": "NCBI Taxonomy ID",
209+
"description": "NCBI taxonomy id - e.g. 9606 is the id for Homo sapien"
185210
},
186-
"summary_text": {
187-
"type": "string"
211+
"species_common_name": {
212+
"type": "string",
213+
"title": "Species common name",
214+
"description": "Common name for species like human, mouse or rat"
188215
}
189216
}
217+
},
218+
"summary_text": {
219+
"type": "string",
220+
"title": "Summary Text",
221+
"description": "Abstract from source text to provide support for this evidence"
190222
}
191223
}
192224
}
225+
}
226+
}

0 commit comments

Comments
 (0)