Changes for page Technical details

Last modified by lzehl on 2021/07/05 18:57
From version 36.1
edited by lzehl
on 2021/03/08 22:33
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
... ... @@ -18,7 +18,7 @@
18 18  === The openMINDS schema template syntax ===
19 19  
20 20  (% style="text-align: justify;" %)
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##**.
21 +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##**.
22 22  
23 23  (% style="text-align: justify;" %)
24 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 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).
... ... @@ -73,11 +73,12 @@
73 73  
74 74  {{code language="json"}}
75 75  {
76 - "_type": "https:~/~/openminds.ebrains.eu/core/Dataset",
77 - "_extends": "products/researchProduct.schema.tpl.json"
76 + "_type": "https:~/~/openminds.ebrains.eu/core/Dataset",
77 + "_extends": "products/researchProduct.schema.tpl.json"
78 78  }
79 79  {{/code}}
80 80  
81 +(% style="text-align: justify;" %)
81 81  Note that this convention requires the concept and corresponding target templates to be located in the same openMINDS metadata model repository. Note also that for properties, the following rules apply for target and concept template: 
82 82  
83 83  1. A concept template has to define some properties which will be inherited by all extending target templates.
... ... @@ -85,28 +85,69 @@
85 85  1. A target template can require properties of the concept template, that are not explicitly required within the concept template. In such a case, the other target templates extending the same concept template will not require those properties.
86 86  1. A target template can (but does not have to) define and require additional properties that were not defined and required in the concept template. These additionally defined and required properties will not be shared with the other target templates extending the same concept template.
87 87  
89 +(% style="text-align: justify;" %)
88 88  How to define the expected value of a property will be explained for the different property types in the following sections.
89 89  
90 90  (% style="text-align: justify;" %)
91 -===== String properties =====
93 +===== Properties expecting a string value =====
92 92  
93 93  (% style="text-align: justify;" %)
94 -(//**coming soon**//)
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:
95 95  
98 +{{code language="json"}}
99 +{
100 + "properties": {
101 + "freeStringProperty": {
102 + "type": "string"
103 + }
104 + }
105 +}
106 +{{/code}}
107 +
96 96  (% style="text-align: justify;" %)
97 -===== Numerical properties =====
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:
98 98  
111 +{{code language="json"}}
112 +{
113 + "properties": {
114 + "emailProperty": {
115 + "type": "string",
116 + "_formats": [
117 + "email"
118 + ]
119 + }
120 + }
121 +}
122 +{{/code}}
123 +
99 99  (% 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:
126 +
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;" %)
100 100  (//**coming soon**//)
101 101  
102 102  (% style="text-align: justify;" %)
103 -===== Object properties =====
145 +===== Properties expecting another object =====
104 104  
105 105  (% style="text-align: justify;" %)
106 106  (//**coming soon**//)
107 107  
108 108  (% style="text-align: justify;" %)
109 -===== Property arrays =====
151 +===== Properties expecting an array of values =====
110 110  
111 111  (% style="text-align: justify;" %)
112 112  (//**coming soon**//)
Public

openMINDS