JSON MetaschemaΒΆ

cis_interface uses the JSON metaschema below for evaluating schemas including type definitions. This metaschema is an expansion of the default metaschema defined by JSON schema with the addition of several more specific simpleTypes that allow validation of more complex/specific data types.

Data types in the cis_interface metaschema that are not part of the JSON schema metaschema include:

1darray:One dimensional arrays with elements of uniform size that are contiguous in memory.
bytes:Raw bytes (to allow encoding of bytes objects in Python 3.6).
complex:Complex numbers.
float:Floating point number with support for numpy floats in addition to the Python build-in.
function:Python callable.
int:Integer number with support for numpy ints in addition to the Python build-in.
ndarray:Multi-dimensional arrays with elements of uniform size that are continguous in memory in C order.
obj:Wavefront OBJ representation of a 3D geometry.
ply:Polygon File Format representation of a 3D geometry.
scalar:Generic scalar that has an optional subtype.
schema:A JSON schema.
uint:Unsigned integer number with support for numpy uints.
unicode:Unicode objects that will be encoded as bytes using utf-8 encoding.
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
{
    "default": {}, 
    "definitions": {
        "positiveInteger": {
            "minimum": 0, 
            "type": "integer"
        }, 
        "positiveIntegerDefault0": {
            "allOf": [
                {
                    "$ref": "#/definitions/positiveInteger"
                }, 
                {
                    "default": 0
                }
            ]
        }, 
        "schemaArray": {
            "items": {
                "$ref": "#"
            }, 
            "minItems": 1, 
            "type": "array"
        }, 
        "simpleTypes": {
            "enum": [
                "array", 
                "boolean", 
                "integer", 
                "null", 
                "number", 
                "object", 
                "string", 
                "1darray", 
                "bytes", 
                "complex", 
                "float", 
                "function", 
                "int", 
                "ndarray", 
                "obj", 
                "ply", 
                "scalar", 
                "schema", 
                "uint", 
                "unicode"
            ]
        }, 
        "stringArray": {
            "items": {
                "type": "string"
            }, 
            "minItems": 1, 
            "type": "array", 
            "uniqueItems": true
        }
    }, 
    "dependencies": {
        "exclusiveMaximum": [
            "maximum"
        ], 
        "exclusiveMinimum": [
            "minimum"
        ]
    }, 
    "description": "Core schema meta-schema", 
    "id": "http://json-schema.org/draft-04/schema#", 
    "properties": {
        "$schema": {
            "format": "uri", 
            "type": "string"
        }, 
        "additionalItems": {
            "anyOf": [
                {
                    "type": "boolean"
                }, 
                {
                    "$ref": "#"
                }
            ], 
            "default": {}
        }, 
        "additionalProperties": {
            "anyOf": [
                {
                    "type": "boolean"
                }, 
                {
                    "$ref": "#"
                }
            ], 
            "default": {}
        }, 
        "allOf": {
            "$ref": "#/definitions/schemaArray"
        }, 
        "anyOf": {
            "$ref": "#/definitions/schemaArray"
        }, 
        "default": {}, 
        "definitions": {
            "additionalProperties": {
                "$ref": "#"
            }, 
            "default": {}, 
            "type": "object"
        }, 
        "dependencies": {
            "additionalProperties": {
                "anyOf": [
                    {
                        "$ref": "#"
                    }, 
                    {
                        "$ref": "#/definitions/stringArray"
                    }
                ]
            }, 
            "type": "object"
        }, 
        "description": {
            "type": "string"
        }, 
        "enum": {
            "minItems": 1, 
            "type": "array", 
            "uniqueItems": true
        }, 
        "exclusiveMaximum": {
            "default": false, 
            "type": "boolean"
        }, 
        "exclusiveMinimum": {
            "default": false, 
            "type": "boolean"
        }, 
        "format": {
            "type": "string"
        }, 
        "id": {
            "format": "uri", 
            "type": "string"
        }, 
        "items": {
            "anyOf": [
                {
                    "$ref": "#"
                }, 
                {
                    "$ref": "#/definitions/schemaArray"
                }
            ], 
            "default": {}
        }, 
        "length": {
            "description": "Number of elements in the 1D array.", 
            "minimum": 1, 
            "type": "number"
        }, 
        "maxItems": {
            "$ref": "#/definitions/positiveInteger"
        }, 
        "maxLength": {
            "$ref": "#/definitions/positiveInteger"
        }, 
        "maxProperties": {
            "$ref": "#/definitions/positiveInteger"
        }, 
        "maximum": {
            "type": "number"
        }, 
        "minItems": {
            "$ref": "#/definitions/positiveIntegerDefault0"
        }, 
        "minLength": {
            "$ref": "#/definitions/positiveIntegerDefault0"
        }, 
        "minProperties": {
            "$ref": "#/definitions/positiveIntegerDefault0"
        }, 
        "minimum": {
            "type": "number"
        }, 
        "multipleOf": {
            "exclusiveMinimum": true, 
            "minimum": 0, 
            "type": "number"
        }, 
        "not": {
            "$ref": "#"
        }, 
        "oneOf": {
            "$ref": "#/definitions/schemaArray"
        }, 
        "pattern": {
            "format": "regex", 
            "type": "string"
        }, 
        "patternProperties": {
            "additionalProperties": {
                "$ref": "#"
            }, 
            "default": {}, 
            "type": "object"
        }, 
        "precision": {
            "description": "The size (in bits) of each item.", 
            "minimum": 1, 
            "type": "number"
        }, 
        "properties": {
            "additionalProperties": {
                "$ref": "#"
            }, 
            "default": {}, 
            "type": "object"
        }, 
        "required": {
            "$ref": "#/definitions/stringArray"
        }, 
        "shape": {
            "description": "Shape of the ND array in each dimension.", 
            "items": {
                "minimum": 1, 
                "type": "integer"
            }, 
            "type": "array"
        }, 
        "subtype": {
            "description": "The base type for each item.", 
            "enum": [
                "bytes", 
                "complex", 
                "float", 
                "int", 
                "uint", 
                "unicode"
            ], 
            "type": "string"
        }, 
        "title": {
            "type": "string"
        }, 
        "type": {
            "anyOf": [
                {
                    "$ref": "#/definitions/simpleTypes"
                }, 
                {
                    "items": {
                        "$ref": "#/definitions/simpleTypes"
                    }, 
                    "minItems": 1, 
                    "type": "array", 
                    "uniqueItems": true
                }
            ]
        }, 
        "uniqueItems": {
            "default": false, 
            "type": "boolean"
        }, 
        "units": {
            "description": "Physical units.", 
            "type": "string"
        }
    }, 
    "title": "Cis meta-schema for data type schemas", 
    "type": "object"
}