Schema Conventions
# Comment
SYNOPSIS = {
field_name: 'text',
sub_object: SUBOBJECT
}
SUBOBJECT = {
array_of_things: [THINGS]
}
- CAPS for subobjects that are described below/above
'type' for type references. - Arrays are generally unbounded, except where mentioned.
Types used
| Type |
Description |
text |
A simple UTF-8 encoded string of characters. |
one of "a", "b", ... |
Field will always contain one of the values given. Explanation should follow in the text. |
bool |
Either true or false; boolean. |
integer |
An integer number |
object |
Any data type at all. Used in places where the interface implementor doesn't need to worry about the content of a variable. |