Changes for page Technical details
Last modified by lzehl on 2021/07/05 18:57
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -111,34 +111,30 @@ 111 111 === The openMINDS schema template syntax === 112 112 113 113 (% style="text-align: justify;" %) 114 -All openMINDS metadata models are definedusinga light-weighted schema template syntax.Although this schema template syntax is inspiredby JSON-Schema, it outsources most schema technicalities to be handledinthe openMINDSintegrationpipeline, makingtheopenMINDS schemasmorehuman-readable, especially for untrained eyes. Thefew remainingcustomized technical propertieswhich need additional interpretationare prefixedthe syntaxwith **##"_"##**. Within theopenMINDS integration pipeline (cf. below),the schematemplate syntax is interpreted, extended andflexibly translatedto variousformal metadataformats (e.g., JSON-Schema).Thespecificationsf the openMINDSschemaemplatesyntax are described in following.114 +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##**. 115 115 116 116 (% style="text-align: justify;" %) 117 -All openMINDS schemas ne edtohave the extension**##.schema.tpl.json##**andeachschemais definedasa nestedassociativearray(dictionary)withthefollowingconceptual structure: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). 118 118 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 - 133 133 (% style="text-align: justify;" %) 134 - **##"_type"##** definesthe schema type (or namespace) with the depictednamingconvention,wherethelabeloftherespectiveopenMINDSmetadatamodel(e.g.,**##"core"##**)andtheschemaname(format:UpperCamelCase;e.g. **##"Person"##**)havetobespecified.The schemanameshouldbemeaningful andprovidesomeinsidesinto whatmetadatacontenttheschemacovers.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. 135 135 136 136 (% style="text-align: justify;" %) 137 - Under **##"properties"##**a nestedassociatedarrayis defined, whereeach keydefinestheproperty name (format: lowerCamelCase;e.g. **##"givenName"##**) andthe associatedvalue isagain a nestedassociatedarraydefiningthe expected data **##"type"##** and the **##"_instructions"##**forenteringthecorrectmetadatafortherespectiveproperty.Currentlythe openMINDS schema template syntax supports theollowing data types: **##"string,**##"integer"##**, **##"float"##**, **##"boolean"##**,**##"array"##**and**##"object"##**.Dependingonthe expected dataype additional constraintscanbemadeforthemetadata entryofarespectiveproperty(cf. below).123 +For the more inexperienced programmers, let's start by explaining first some general terms that will be later used in the openMINDS schema template syntax specification. More experienced programmers can of course skip these explanations and jump directly further down. 138 138 139 -(% style="text-align: justify;" %) 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. 125 +**What is a string, an integer, a float or a boolean?** 141 141 127 +**What is a key-value pair?** 128 + 129 +**What is a list?** 130 + 131 +**What is a dictionary?** 132 + 133 +**What is a JSON?** 134 + 135 + 136 + 137 + 142 142 === The openMINDS integration pipeline === 143 143 144 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