Changes for page Technical details

Last modified by lzehl on 2021/07/05 18:57
From version 57.1
edited by lzehl
on 2021/06/23 14:09
Change comment: There is no comment for this version
To version 61.1
edited by lzehl
on 2021/06/24 12:28
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -60,13 +60,13 @@
60 60  Through the integration pipeline of the openMINDS generator, the openMINDS vocabulary is automatically gathered and stored in the main openMINDS GitHub in order to centrally maintain general definitions and references for **types** and **properties** used in schemas across all openMINDS repositories. How this works is explained in the following.
61 61  
62 62  (% style="text-align: justify;" %)
63 -Schema types and properties are stored in dedicated JSON files (**##types.json##** and **##properties.json##**) under the folder **##vocab##** located in the main openMINDS GitHub directory. Each schema type and property occurring in the openMINDS metadata models is automatically represented in those files as nested dictionaries. Here a cutout of the **##types.json##** and **##properties.json##**:
63 +Schema types and properties are stored in dedicated JSON files (**##types.json##** and **##properties.json##**) under the folder **##vocab##** located in the main openMINDS GitHub directory. Each schema type and property occurring in the openMINDS metadata models is automatically represented in those files as nested dictionaries. Here a cutout of the **##types.json##**:
64 64  
65 65  {{code language="json"}}
66 66  {
67 67   ...,
68 68   "https://openminds.ebrains.eu/core/Person": {
69 - "description": "Structured information on a person.",
69 + "description": "Structured information on a person (alive or dead).",
70 70   "name": "Person",
71 71   "translatableTo": [
72 72   "https://schema.org/Person"
... ... @@ -76,6 +76,8 @@
76 76  }
77 77  {{/code}}
78 78  
79 +... and a cutout of the **##properties.json##**:
80 +
79 79  {{code language="json"}}
80 80  {
81 81   ...,
... ... @@ -95,9 +95,12 @@
95 95  {{/code}}
96 96  
97 97  (% style="text-align: justify;" %)
98 -The keywords of those nested dictionaries are pre-defined to consistently capture for all schema types and properties their namespace, their occurrence, their general description, and possible references to related or matching schema types and properties of other metadata initiatives (e.g., schema.org). This setup also allows us to define some values/entries to be automatically filled in by the openMINDS integration pipeline with each commit to one of the openMINDS repositories (e.g., the namespace and occurrence) and others to be manually editable later on (e.g., the general description and references).
100 +The keywords of those nested dictionaries are pre-defined to consistently capture for all schema types and properties their namespace, their occurrence (cf. **##"schemas"##** in **##properties.json##**), their general description (cf. **##"description"##** in **##types.json##** and **##properties.json##**), and possible references to related or matching schema types (cf. **##"translatableTo"##** in **##types.json##**) and properties (cf. **##""sameAs""##** in **##properties.json##**) of other metadata initiatives (e.g., schema.org).
99 99  
100 100  (% style="text-align: justify;" %)
103 +This setup also allows us to define some values/entries to be automatically filled in by the openMINDS integration pipeline with each commit to one of the openMINDS repositories (**##"name"##**, **##"schemas"##**) and others to be manually editable later on (**##"description"##**, **##"translatableTo"##**, **##"sameAs"##**, **##"nameForReverseLink"##**).
104 +
105 +(% style="text-align: justify;" %)
101 101  For security, outdated entries in those openMINDS vocabulary files (e.g., because the namespace of the schema type or property changed or the schema type or property was deleted) are not automatically deleted, but kept and marked as being deprecated. After evaluation, deprecated schema types or properties can be deleted manually from openMINDS vocabulary.
102 102  
103 103  (% style="text-align: justify;" %)
... ... @@ -109,17 +109,37 @@
109 109  All openMINDS metadata models use a light-weighted schema template syntax for defining the expected metadata. The correspondingly formatted schema files use the extension: **##.schema.tpl.json##**.
110 110  
111 111  (% style="text-align: justify;" %)
112 -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 them 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).
117 +Although, as the file extension suggests, this openMINDS schema template syntax is inspired by JSON-Schema, it facilitates or even excludes technical aspects making the openMINDS schemas 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).
113 113  
114 114  (% style="text-align: justify;" %)
115 -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.
120 +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. Please find in the following a full documentation of the openMINDS schema template syntax and how it's key-value pairs need to be defined and interpreted.
116 116  
117 117  (% style="text-align: justify;" %)
118 -Please find in the following a full documentation of the openMINDS schema template syntax and how it's key-value pairs need to be defined and interpreted.
123 +Let's start by going through the syntax of a simple openMINDS schema, the contactInformation.schema.tpl.json:
119 119  
125 +{{code language="json"}}
126 +{
127 + "_type": "https://openminds.ebrains.eu/core/ContactInformation",
128 + "required": [
129 + "email"
130 + ],
131 + "properties": {
132 + "email": {
133 + "type": "string",
134 + "_formats": [
135 + "email"
136 + ],
137 + "_instruction": "Enter the email address of this person."
138 + }
139 + }
140 +}
141 +{{/code}}
142 +
120 120  (% style="text-align: justify;" %)
121 -(//**coming soon**//)
144 +The **##"_type"##** identifies the schema type or namespace for the particular schema. In **##"required"##** all property names have to be listed{{footnote}}A list is a data structure that is an ordered sequence of elements. Each element inside of a list is typically called an item. Lists are defined by having values between square brackets **##[ ]##**.{{/footnote}} that must be provided and filled out in a valid instance of this schema type (here, only the property **##"email"##** is required). Under **##"properties"##**, information about the expected value for each property defining the particular schema is given in a nested dictionary{{footnote}}A dictionary is a data structure that consists of an unordered collection of key:value pairs. Dictionaries are defined by having these key:value pairs between curly brackets **##{...}##**.{{/footnote}} (here, the only property is **##"email"##**). In this nested dictionary the **##"type"##** of the expected value should be specified (here, a value of type **##"string"##**{{footnote}}Strings are defined as characters between quotes **##"..."##**.{{/footnote}} is expected). For values of type **##"string"##** it is further possible to list the accepted formats of the **##"string"##** under **##"_formats"##** (here, the expected **##"string"##** value has to be an email).
122 122  
123 123  === The openMINDS integration pipeline ===
124 124  
125 -(//**coming soon**//)
148 +(//**coming soon**//) If you'd like to learn more about the openMINDS integration pipeline, especially if you'd like to contribute to it, please get in touch with us (the openMINDS development team) via the issues on the openMINDS or openMINDS_generator GitHub or the support email: openminds@ebrains.eu
149 +
150 +{{putFootnotes/}}
Public

openMINDS