Wiki source code of Technical details
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
3.1 | 1 | (% class="box infomessage" %) |
| 2 | ((( | ||
| |
5.1 | 3 | (% style="text-align: justify;" %) |
| |
4.1 | 4 | openMINDS is designed as modular as possible, in order to facilitate extensions and maintenance of existing, as well as development and integration of new metadata models and schemas. The layout and technical requirements for this modularity are described below. |
| 5 | |||
| |
5.1 | 6 | (% style="text-align: justify;" %) |
| |
4.1 | 7 | In parallel, openMINDS tries to consider the various programming skills present in the neuroscience research community. For this reason, openMINDS established an integration pipeline which gradually increases the level of technical detail: starting from a user-friendly, lightweight schema template and ending with established, highly technical metadata schema formats (e.g., JSON-Schema). |
| 8 | |||
| |
5.1 | 9 | (% style="text-align: justify;" %) |
| |
8.1 | 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. |
| |
3.1 | 11 | ))) |
| |
5.2 | 12 | |
| |
7.1 | 13 | === Overview of the openMINDS layout === |
| |
5.2 | 14 | |
| |
10.1 | 15 | (% style="text-align: justify;" %) |
| |
8.1 | 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. |
| |
6.1 | 17 | |
| |
7.1 | 18 | === The openMINDS schema template syntax === |
| |
6.1 | 19 | |
| |
9.1 | 20 | (% style="text-align: justify;" %) |
| |
11.1 | 21 | All openMINDS metadata models use a light-weighted schema template syntax for defining the metadata. The correspondingly formatted schema files use the extension: **##.schema.tpl.json##**. |
| |
6.1 | 22 | |
| |
10.1 | 23 | (% style="text-align: justify;" %) |
| |
17.1 | 24 | Although, as the file extension suggests, this openMINDS schema template syntax is inspired by JSON-Schema, it facilitates or even excludes technical aspects that are generally expected for the openMINDS schemas making it more human-readable, especially for untrained eyes. Behind the scenes, within the openMINDS integration pipeline (cf. below), this schema template syntax is then interpreted and flexibly translated to various formal metadata formats (e.g., JSON-Schema). |
| |
9.1 | 25 | |
| |
11.1 | 26 | (% style="text-align: justify;" %) |
| |
18.1 | 27 | Despite the simplification in comparison to JSON-Schema, the openMINDS schema templates are also, at the core, specially formatted JSON files using a particular syntax, meaning special key-value pairs that define the validation rules of a schema. |
| |
10.1 | 28 | |
| |
12.1 | 29 | (% style="text-align: justify;" %) |
| |
18.1 | 30 | Please find in the following a full documentation of the openMINDS schema template syntax and how the key-value pairs need to be defined and interpreted. |
| 31 | |||
| 32 | (% style="text-align: justify;" %) | ||
| |
14.1 | 33 | ===== Target & context templates ===== |
| |
10.1 | 34 | |
| |
16.1 | 35 | (% style="text-align: justify;" %) |
| |
17.1 | 36 | An openMINDS schema //HAS TO HAVE// a **##"_type"##** to be recognized as **target template**. In other words, the **##"_type"##** is used to define the openMINDS namespace of a corresponding schema using the following naming convention: |
| |
14.1 | 37 | |
| |
15.1 | 38 | (% style="text-align: center;" %) |
| 39 | **##"_type": "https:~/~/openminds.ebrains.eu/<<schema-model>>/<<schema-name>>"##**, | ||
| |
14.1 | 40 | |
| |
16.1 | 41 | (% style="text-align: justify;" %) |
| |
12.1 | 42 | where **##<<schema-model>>##** has to be replaced with the label of the openMINDS metadata model the corresponding schema belongs to and **##<<schema-name>>##** exchanged with the label of that schema. |
| |
11.1 | 43 | |
| |
16.1 | 44 | (% style="text-align: justify;" %) |
| |
20.1 | 45 | If an openMINDS schema template file //DOES NOT// define a **##"_type"##**, it is interpreted as a **context template** which //HAS TO BE// extended to a target template. |
| |
12.1 | 46 | |
| |
15.1 | 47 | (% style="text-align: justify;" %) |
| |
16.1 | 48 | Context templates are and should be used when multiple openMINDS schemas (target templates) have the same subset of properties. This common subset of properties can then be defined within a single context schema instead of each target template which facilitates the long-term maintenance of these properties. |
| 49 | |||
| 50 | (% style="text-align: justify;" %) | ||
| |
20.1 | 51 | To define that a target template is the extension of a context template, the target template can state under **##"_extends"##** the relative path to the context template. Note that this requires the context and corresponding target templates to be located in the same openMINDS metadata model repository. |
| |
17.1 | 52 | |
| 53 | (% style="text-align: justify;" %) | ||
| |
15.1 | 54 | ===== String properties ===== |
| 55 | |||
| 56 | (% style="text-align: justify;" %) | ||
| 57 | (//**coming soon**//) | ||
| 58 | |||
| 59 | (% style="text-align: justify;" %) | ||
| 60 | ===== Numerical properties ===== | ||
| 61 | |||
| 62 | (% style="text-align: justify;" %) | ||
| 63 | (//**coming soon**//) | ||
| 64 | |||
| 65 | (% style="text-align: justify;" %) | ||
| 66 | ===== Object properties ===== | ||
| 67 | |||
| 68 | (% style="text-align: justify;" %) | ||
| 69 | (//**coming soon**//) | ||
| 70 | |||
| 71 | (% style="text-align: justify;" %) | ||
| 72 | ===== Property arrays ===== | ||
| 73 | |||
| 74 | (% style="text-align: justify;" %) | ||
| 75 | (//**coming soon**//) | ||
| 76 | |||
| 77 | |||
| |
6.1 | 78 | === The openMINDS integration pipeline === |
| 79 | |||
| 80 | (//**coming soon**//) |