Interface IJsonSchema

Definition for a JSON Schema

Export

IJsonSchema

Hierarchy

  • IJsonSchema

Properties

$id?: string

This is important because it tells refs where the root of the document is located

$ref?: string
$schema?: string
additionalItems?: boolean | IJsonSchema
additionalProperties?: boolean | IJsonSchema
allOf?: IJsonSchema[]
anyOf?: IJsonSchema[]
default?: any

Default json for the object represented by

definitions?: {
    [key: string]: IJsonSchema;
}

Holds simple JSON Schema definitions for referencing from elsewhere.

Type declaration

dependencies?: {
    [key: string]: IJsonSchema | string[];
}

If 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.

Type declaration

description?: string

Schema description

enum?: any[]

Enumerates the values that this schema can be e.g.

{ "type": "string", "enum": ["red", "green", "blue"] }

examples?: any
exclusiveMaximum?: boolean

If true maximum must be > value, >= otherwise

exclusiveMinimum?: boolean

If true minimum must be < value, <= otherwise

maxItems?: number
maxLength?: number
maxProperties?: number
maximum?: number
minItems?: number
minLength?: number
minProperties?: number
minimum?: number
multipleOf?: number

The value must be a multiple of the number (e.g. 10 is a multiple of 5)

The entity being validated must not match this schema

oneOf?: IJsonSchema[]
pattern?: string

This is a regex string that the value must conform to

patternProperties?: {
    [pattern: string]: IJsonSchema;
}

The key of this object is a regex for which properties the schema applies to

Type declaration

properties?: {
    [property: string]: IJsonSchema;
}

The keys that can exist on the object with the json schema that should validate their value

Type declaration

required?: string[]

Props that must be integrated

title?: string

Title of the schema

The basic type of this schema, can be one of ['string' | 'number' | 'object' | 'array' | 'boolean' | 'null'] or an array of the acceptable types

uniqueItems?: boolean

Generated using TypeDoc