Changes for page Technical details

Last modified by lzehl on 2021/07/05 18:57
From version 55.1
edited by lzehl
on 2021/06/23 13:45
Change comment: There is no comment for this version
To version 67.1
edited by lzehl
on 2021/06/24 18:56
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -60,12 +60,49 @@
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.
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 +{{code language="json"}}
66 +{
67 + ...,
68 + "https://openminds.ebrains.eu/core/Person": {
69 + "description": "Structured information on a person (alive or dead).",
70 + "name": "Person",
71 + "translatableTo": [
72 + "https://schema.org/Person"
73 + ]
74 + },
75 + ...
76 +}
77 +{{/code}}
78 +
79 +... and a cutout of the **##properties.json##**:
80 +
81 +{{code language="json"}}
82 +{
83 + ...,
84 + "givenName": {
85 + "description": "Name given to a person, including all potential middle names, but excluding the family name.",
86 + "name": "Given name",
87 + "nameForReverseLink": "Is given name of",
88 + "sameAs": [
89 + "https://schema.org/givenName"
90 + ],
91 + "schemas": [
92 + "core/v3/actors/person.schema.tpl.json"
93 + ]
94 + },
95 + ...
96 +}
97 +{{/code}}
98 +
65 65  (% style="text-align: justify;" %)
66 -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).
67 67  
68 68  (% 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;" %)
69 69  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.
70 70  
71 71  (% style="text-align: justify;" %)
... ... @@ -74,20 +74,36 @@
74 74  === The openMINDS schema template syntax ===
75 75  
76 76  (% style="text-align: justify;" %)
77 -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##**.
114 +All openMINDS metadata models are defined using a light-weighted schema template syntax. Although this schema template syntax is inspired by JSON-Schema, it outsources most schema technicalities to be handled in the openMINDS integration pipeline, making the openMINDS schemas more human-readable, especially for untrained eyes. The few remaining customized technical properties which need additional interpretation are prefixed in the syntax with **##"_"##**. Within the openMINDS integration pipeline (cf. below), the schema template syntax is interpreted, extended and flexibly translated to various formal metadata formats (e.g., JSON-Schema). The specifications of the openMINDS schema template syntax are described in following.
78 78  
79 79  (% style="text-align: justify;" %)
80 -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 +All openMINDS schemas need to have the extension **##.schema.tpl.json##** and each schema is defined as a nested associative array (dictionary) with the following conceptual structure:
81 81  
119 +{{code language="json"}}
120 +{
121 + "_type": "https://openminds.ebrains.eu/LABEL_OF_METADATA_MODEL/SCHEMA_NAME",
122 + "properties": {
123 + "PROPERTY_NAME": {
124 + "type": "DATA_TYPE",
125 + "_instruction": "METADATA_ENTRY_INSTRUCTION"
126 + },
127 + "required": [
128 + "PROPERTY_NAME"
129 + ]
130 +}
131 +{{/code}}
132 +
82 82  (% style="text-align: justify;" %)
83 -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.
134 +**##"_type"##** defines the schema type (or namespace) with the depicted naming convention, where the label of the respective openMINDS metadata model (e.g., **##"core"##**) and the schema name (format: UpperCamelCase; e.g. **##"Person"##**) have to be specified. The schema name should be meaningful and provide some insides into what metadata content the schema covers.
84 84  
85 85  (% style="text-align: justify;" %)
86 -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.
137 +Under **##"properties"##** a nested associated array is defined, where each key defines the property name (format: lowerCamelCase; e.g. **##"givenName"##**) and the associated value is again a nested associated array defining the expected data **##"type"##** and the **##"_instructions"##** for entering the correct metadata for the respective property. Currently the openMINDS schema template syntax supports the following data types: **##"string, **##"integer"##**, **##"float"##**, **##"boolean"##**, **##"array"##** and **##"object"##**. Depending on the expected data type additional constraints can be made for the metadata entry of a respective property (cf. below).
87 87  
88 88  (% style="text-align: justify;" %)
89 -(//**coming soon**//)
140 +Under **##"required"##** a list of property names can be provided that are obligatory to be present in a correctly instantiated metadata instance of the respective schema. If none of the properties are required, this key-value pair does not have to be specified.
90 90  
91 91  === The openMINDS integration pipeline ===
92 92  
93 -(//**coming soon**//)
144 +(//**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
145 +
146 +{{putFootnotes/}}
Public

openMINDS