Optional
$idThis is important because it tells refs where the root of the document is located
Optional
$refOptional
$schemaOptional
additionalOptional
additionalOptional
allOptional
anyOptional
defaultDefault json for the object represented by
Optional
definitionsHolds simple JSON Schema definitions for referencing from elsewhere.
Optional
dependenciesIf the key is present as a property then the string of properties must also be present. If the value is a JSON Schema then it must also be valid for the object if the key is present.
Optional
descriptionSchema description
Optional
enumEnumerates the values that this schema can be e.g.
{ "type": "string", "enum": ["red", "green", "blue"] }
Optional
examplesOptional
exclusiveIf true maximum must be > value, >= otherwise
Optional
exclusiveIf true minimum must be < value, <= otherwise
Optional
itemsOptional
maxOptional
maxOptional
maxOptional
maximumOptional
minOptional
minOptional
minOptional
minimumOptional
multipleThe value must be a multiple of the number (e.g. 10 is a multiple of 5)
Optional
notThe entity being validated must not match this schema
Optional
oneOptional
patternThis is a regex string that the value must conform to
Optional
patternThe key of this object is a regex for which properties the schema applies to
Optional
propertiesThe keys that can exist on the object with the json schema that should validate their value
Optional
requiredProps that must be integrated
Optional
titleTitle of the schema
Optional
typeThe basic type of this schema, can be one of ['string' | 'number' | 'object' | 'array' | 'boolean' | 'null'] or an array of the acceptable types
Optional
uniqueGenerated using TypeDoc
Definition for a JSON Schema
Export
IJsonSchema