Changes for page Technical details

Last modified by lzehl on 2021/07/05 18:57
From version 43.1
edited by lzehl
on 2021/03/17 17:09
Change comment: There is no comment for this version
To version 40.1
edited by lzehl
on 2021/03/09 16:52
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -10,23 +10,11 @@
10 10  Please find below a documentation of the layout and requirements needed to keep the openMINDS modularity, the syntax of the openMINDS schema template, as well as the openMINDS integration pipeline.
11 11  )))
12 12  
13 -=== The openMINDS umbrella ===
13 +=== Overview of the openMINDS layout ===
14 14  
15 15  (% style="text-align: justify;" %)
16 16  In summary, openMINDS is the overall umbrella for a set of distributed GitHub repositories, each defining a particular metadata model for neuroscience research products.
17 17  
18 -(% style="text-align: justify;" %)
19 -The main (or central) [[openMINDS GitHub repository>>https://github.com/HumanBrainProject/openMINDS||rel="noopener noreferrer" target="_blank"]] ingests all these GitHub repositories as submodules. Furthermore it defines the openMINDS vocabulary (**##vocab##**) used for **##types##** and **##properties##** across all schemas independent of their original repository (cf. below). And last but not least, it holds the schema representations for all supported metadata formats created by the openMINDS generator pipeline.
20 -
21 -(% style="text-align: justify;" %)
22 -For this to work smoothly for the existing, but also for all new openMINDS metadata models, the corresponding openMINDS submodules (GitHub repositories) have to meet the following requirements:
23 -((% style="color:#7f8c8d" %)//**coming soon**//(%%))
24 -
25 -=== The openMINDS vocabulary ===
26 -
27 -(% style="text-align: justify;" %)
28 -((% style="color:#7f8c8d" %)//**coming soon**//(%%))
29 -
30 30  === The openMINDS schema template syntax ===
31 31  
32 32  (% style="text-align: justify;" %)
... ... @@ -50,13 +50,13 @@
50 50  {{code language="json"}}
51 51  {
52 52   "properties": {
53 - "propertyNameA": {},
54 - "propertyNameB": {},
55 - "propertyNameC": {}
41 + "propertyNameA": {},
42 + "propertyNameB": {},
43 + "propertyNameC": {}
56 56   },
57 57   "required": [
58 - "propertyNameA",
59 - "propertyNameC"
46 + "propertyNameA",
47 + "propertyNameC"
60 60   ]
61 61  }
62 62  {{/code}}
... ... @@ -85,8 +85,8 @@
85 85  
86 86  {{code language="json"}}
87 87  {
88 - "_type": "https:~/~/openminds.ebrains.eu/core/Dataset",
89 - "_extends": "products/researchProduct.schema.tpl.json"
76 + "_type": "https:~/~/openminds.ebrains.eu/core/Dataset",
77 + "_extends": "products/researchProduct.schema.tpl.json"
90 90  }
91 91  {{/code}}
92 92  
... ... @@ -102,24 +102,70 @@
102 102  How to define the expected value of a property will be explained for the different property types in the following sections.
103 103  
104 104  (% style="text-align: justify;" %)
105 -===== Defining expected values =====
93 +===== Properties expecting a string value =====
106 106  
107 107  (% style="text-align: justify;" %)
108 -The expected value of a property can be defined in large parts in the same way as in JSON-Schema, with some openMINDS syntax specific simplifications and modifications.
96 +Properties that expect values of type string can be defined in large parts in the same way as in JSON-Schema. Without any further formatting requirements the definition of such a property looks like this:
109 109  
98 +{{code language="json"}}
99 +{
100 + "properties": {
101 + "freeStringProperty": {
102 + "type": "string"
103 + }
104 + }
105 +}
106 +{{/code}}
107 +
110 110  (% style="text-align: justify;" %)
111 -On the first level, the **##"type"##** of the expected property value needs to be defined. In principle, the openMINDS template syntax supports the same value types as JSON-Schema Draft 7.0, meaning:
112 -+ **##"string"##**
113 -+ **##"number"##**
114 -+ **##"integer"##**
115 -+ **##"array"##**
116 -+ **##"boolean"##**
117 -+ **##"null"##**
118 -+ **##"object"##** 
109 +In accordance with JSON-Schema, it is possible, though, to further define a selected list of built-in formats that are accepted for the expected string. Supported are all [[built-in formats of JSON-Schema Draft 7.0>>https://json-schema.org/understanding-json-schema/reference/string.html#built-in-formats||rel="noopener noreferrer" target="_blank"]]. Assuming that my string property only accepts a value of format "email", the openMINDS syntax is the following:
119 119  
120 -Also very similar to JSON-Schema, additional type-specific keys can be used to set further requirements for the expected value. H
111 +{{code language="json"}}
112 +{
113 + "properties": {
114 + "emailProperty": {
115 + "type": "string",
116 + "_formats": [
117 + "email"
118 + ]
119 + }
120 + }
121 +}
122 +{{/code}}
121 121  
124 +(% style="text-align: justify;" %)
125 +Also like JSON-Schema, it is possible to define a customized regular expression pattern for the expected string, supporting the [[ECMA-262 regex-dialect>>https://www.ecma-international.org/publications-and-standards/standards/ecma-262/]]. Assuming that my string property only accepts a Gregorian calendar year, the corresponding openMINDS syntax look like this:
122 122  
127 +{{code language="json"}}
128 +{
129 + "properties": {
130 + "yearProperty": {
131 + "type": "string",
132 + "pattern": "([0-9]{4})"
133 + }
134 + }
135 +}
136 +{{/code}}
137 +
138 +(% style="text-align: justify;" %)
139 +===== Properties expecting a numerical value =====
140 +
141 +(% style="text-align: justify;" %)
142 +(//**coming soon**//)
143 +
144 +(% style="text-align: justify;" %)
145 +===== Properties expecting another object =====
146 +
147 +(% style="text-align: justify;" %)
148 +(//**coming soon**//)
149 +
150 +(% style="text-align: justify;" %)
151 +===== Properties expecting an array of values =====
152 +
153 +(% style="text-align: justify;" %)
154 +(//**coming soon**//)
155 +
156 +
123 123  === The openMINDS integration pipeline ===
124 124  
125 125  (//**coming soon**//)
Public

openMINDS