comparison docs/schema.txt @ 19:c3a0fe8d4587

Consistent casing of schema items: all lowercase with dash as separator
author Franz Glasner <fzglas.hg@dom66.de>
date Sat, 08 Jul 2023 10:05:48 +0200
parents 84dfd1a94926
children 449f7c8ede19
comparison
equal deleted inserted replaced
18:94daf3381338 19:c3a0fe8d4587
60 - ``keys`` 60 - ``keys``
61 61
62 `dict` mit Keys und den Values als zugeordnete Schemata für die Values 62 `dict` mit Keys und den Values als zugeordnete Schemata für die Values
63 des Dicts 63 des Dicts
64 64
65 - ``keyNames`` 65 - ``key-names``
66 66
67 Wenn vorhanden: ein Schema, dem die *Keys* -- auch die `additionalKeys` -- 67 Wenn vorhanden: ein Schema, dem die *Keys* -- auch die `additional-keys` --
68 folgen müssen. 68 folgen müssen.
69 69
70 Default: entspricht ``{"type": "string"}`` 70 Default: entspricht ``{"type": "string"}``
71 71
72 - ``additionalKeys`` 72 - ``additional-keys``
73 73
74 * bool 74 * bool
75 75
76 `False` 76 `False`
77 nicht erlaubt (default) 77 nicht erlaubt (default)
92 92
93 - ``required`` 93 - ``required``
94 94
95 Liste von Strings mit Key-Namen, die vorkommen müssen 95 Liste von Strings mit Key-Namen, die vorkommen müssen
96 96
97 - ``maxLength`` 97 - ``max-length``
98 - ``minLength`` 98 - ``min-length``
99 99
100 100
101 list / array 101 list / array
102 ------------ 102 ------------
103 103
107 107
108 - ``items`` 108 - ``items``
109 109
110 Ein Schema für *alle* Items. 110 Ein Schema für *alle* Items.
111 111
112 - ``maxLength`` 112 - ``max-length``
113 - ``minLength`` 113 - ``min-length``
114 114
115 115
116 set / frozenset 116 set / frozenset
117 --------------- 117 ---------------
118 118
122 122
123 - ``items`` 123 - ``items``
124 124
125 Ein Schema für *alle* Items 125 Ein Schema für *alle* Items
126 126
127 - ``maxLength`` 127 - ``max-length``
128 - ``minLength`` 128 - ``min-length``
129 129
130 130
131 tuple / record 131 tuple / record
132 -------------- 132 --------------
133 133
138 138
139 - ``items`` 139 - ``items``
140 140
141 Eine Liste: je ein spezielles Schema *pro Item* 141 Eine Liste: je ein spezielles Schema *pro Item*
142 142
143 - ``additionalItems`` 143 - ``additional-items``
144 144
145 * bool 145 * bool
146 146
147 `False` 147 `False`
148 nicht erlaubt (default) 148 nicht erlaubt (default)
152 152
153 * Schema 153 * Schema
154 154
155 Prüfung der "zusätzlichen" Items erfolgt nach gegebenem Schema 155 Prüfung der "zusätzlichen" Items erfolgt nach gegebenem Schema
156 156
157 - ``maxLength`` 157 - ``max-length``
158 - ``minLength`` 158 - ``min-length``
159 159
160 160
161 string / str 161 string / str
162 ------------ 162 ------------
163 163
175 - ``is-contained-in-ref`` 175 - ``is-contained-in-ref``
176 176
177 The string's value must be contained in (Python ``in``) in the referenced 177 The string's value must be contained in (Python ``in``) in the referenced
178 object (see `Referenzen`_). 178 object (see `Referenzen`_).
179 179
180 - ``maxLength`` 180 - ``max-length``
181 - ``minLength`` 181 - ``min-length``
182 - ``pattern`` 182 - ``pattern``
183 183
184 * string 184 * string
185 185
186 RE of the accepted pattern 186 RE of the accepted pattern
193 193
194 194
195 binary 195 binary
196 ------ 196 ------
197 197
198 - ``maxLength`` 198 - ``max-length``
199 - ``minLength`` 199 - ``min-length``
200 - ``pattern`` 200 - ``pattern``
201 201
202 * string 202 * string
203 203
204 RE of the accepted pattern. The YAML unicode string value will be 204 RE of the accepted pattern. The YAML unicode string value will be
278 278
279 - ``nullable`` 279 - ``nullable``
280 280
281 bool (Default: False): allow also a None/null/nil 281 bool (Default: False): allow also a None/null/nil
282 282
283 - ``minValue`` 283 - ``min-value``
284 - ``maxValue`` 284 - ``max-value``
285 - ``value`` 285 - ``value``
286 286
287 A callable to validate the integer value 287 A callable to validate the integer value
288 288
289 - ``enum`` 289 - ``enum``
290 290
291 Eine Liste von ganzen Zahlen, von denen genau einer dem vorhandenen 291 Eine Liste von ganzen Zahlen, von denen genau einer dem vorhandenen
292 Wert entsprechen muß. 292 Wert entsprechen muß.
293 293
294 Achtung: Alle anderen Prüfungen (`minValue`, `maxValue`, `value`) 294 Achtung: Alle anderen Prüfungen (`min-value`, `max-value`, `value`)
295 werden trotzdem auch durchgeführt. 295 werden trotzdem auch durchgeführt.
296 296
297 297
298 real / double / float 298 real / double / float
299 --------------------- 299 ---------------------
300 300
301 - ``nullable`` 301 - ``nullable``
302 302
303 bool (Default: False): allow also a None/null/nil 303 bool (Default: False): allow also a None/null/nil
304 304
305 - ``minValue`` 305 - ``min-value``
306 - ``maxValue`` 306 - ``max-value``
307 - ``value`` 307 - ``value``
308 308
309 A callable to validate the float value 309 A callable to validate the float value
310 310
311 311
316 316
317 bool (Default: False): allow also a None/null/nil 317 bool (Default: False): allow also a None/null/nil
318 318
319 Any numeric value (int or float) 319 Any numeric value (int or float)
320 320
321 - ``minValue`` 321 - ``min-value``
322 - ``maxValue`` 322 - ``max-value``
323 - ``value`` 323 - ``value``
324 324
325 A callable to validate the number 325 A callable to validate the number
326 326
327 - ``enum`` 327 - ``enum``
328 328
329 Eine Liste von Zahlen, von denen genau einer dem vorhandenen 329 Eine Liste von Zahlen, von denen genau einer dem vorhandenen
330 Wert entsprechen muß. 330 Wert entsprechen muß.
331 331
332 Achtung: Alle anderen Prüfungen (`minValue`, `maxValue`, `value`) 332 Achtung: Alle anderen Prüfungen (`min-value`, `max-value`, `value`)
333 werden trotzdem auch durchgeführt. 333 werden trotzdem auch durchgeführt.
334 334
335 335
336 scalar 336 scalar
337 ------ 337 ------