Interface JSONSchema

JSON Schema Validation: A Vocabulary for Structural Validation of JSON

interface JSONSchema {
    $id?: string;
    $ref?: string;
    $schema?: string;
    additionalItems?: boolean | JSONSchema;
    additionalProperties?: boolean | JSONSchema;
    allOf?: (boolean | JSONSchema)[];
    anyOf?: (boolean | JSONSchema)[];
    const?: any;
    contains?: boolean | JSONSchema;
    contentEncoding?: string;
    contentMediaType?: string;
    contentSchema?: boolean | JSONSchema;
    default?: any;
    definitions?: Dict<boolean | JSONSchema>;
    dependentRequired?: Dict<boolean | string[] | JSONSchema>;
    dependentSchemas?: Dict<boolean | JSONSchema>;
    description?: string;
    else?: boolean | JSONSchema;
    enum?: any[];
    examples?: any[];
    exclusiveMaximum?: number;
    exclusiveMinimum?: number;
    format?: string;
    if?: boolean | JSONSchema;
    items?: boolean | JSONSchema | (boolean | JSONSchema)[];
    maxContains?: number;
    maximum?: number;
    maxItems?: number;
    maxLength?: number;
    maxProperties?: number;
    minContains?: number;
    minimum?: number;
    minItems?: number;
    minLength?: number;
    minProperties?: number;
    multipleOf?: number;
    not?: boolean | JSONSchema;
    oneOf?: (boolean | JSONSchema)[];
    pattern?: string;
    patternProperties?: Dict<boolean | JSONSchema>;
    prefixItems?: (boolean | JSONSchema)[];
    properties?: Dict<boolean | JSONSchema>;
    propertyNames?: boolean | JSONSchema;
    readOnly?: boolean;
    required?: string[];
    then?: boolean | JSONSchema;
    title?: string;
    type?: JSONSchemaType | JSONSchemaType[];
    unevaluatedItems?: boolean | JSONSchema;
    unevaluatedProperties?: boolean | JSONSchema;
    uniqueItems?: boolean;
    writeOnly?: boolean;
    [key: string]: any;
}

Hierarchy (view full)

Indexable

  • [key: string]: any

Properties

$id? $ref? $schema? additionalItems? additionalProperties? allOf? anyOf? const? contains? contentEncoding? contentMediaType? contentSchema? default? definitions? dependentRequired? dependentSchemas? description? else? enum? examples? exclusiveMaximum? exclusiveMinimum? format? if? items? maxContains? maximum? maxItems? maxLength? maxProperties? minContains? minimum? minItems? minLength? minProperties? multipleOf? not? oneOf? pattern? patternProperties? prefixItems? properties? propertyNames? readOnly? required? then? title? type? unevaluatedItems? unevaluatedProperties? uniqueItems? writeOnly?

Properties

Optional$id

$id?: string

$id in JSON schema spec

Optional$ref

$ref?: string

$ref in JSON schema spec

Optional$schema

$schema?: string

$schema in JSON schema spec

OptionaladditionalItems

additionalItems?: boolean | JSONSchema

Deprecated

additionalItems in JSON schema spec

OptionaladditionalProperties

additionalProperties?: boolean | JSONSchema

additionalProperties in JSON schema spec

OptionalallOf

allOf?: (boolean | JSONSchema)[]

allOf in JSON schema spec

OptionalanyOf

anyOf?: (boolean | JSONSchema)[]

anyOf in JSON schema spec

Optionalconst

const?: any

const in JSON schema spec

Optionalcontains

contains?: boolean | JSONSchema

contains in JSON schema spec

OptionalcontentEncoding

contentEncoding?: string

contentEncoding in JSON schema spec

OptionalcontentMediaType

contentMediaType?: string

contentMediaType in JSON schema spec

OptionalcontentSchema

contentSchema?: boolean | JSONSchema

contentSchema in JSON schema spec

Optionaldefault

default?: any

default in JSON schema spec

Optionaldefinitions

definitions?: Dict<boolean | JSONSchema>

definitions in JSON schema spec

OptionaldependentRequired

dependentRequired?: Dict<boolean | string[] | JSONSchema>

dependentRequired in JSON schema spec

OptionaldependentSchemas

dependentSchemas?: Dict<boolean | JSONSchema>

dependentSchemas in JSON schema spec

Optionaldescription

description?: string

description in JSON schema spec

Optionalelse

else?: boolean | JSONSchema

else in JSON schema spec

Optionalenum

enum?: any[]

enum in JSON schema spec

Optionalexamples

examples?: any[]

examples in JSON schema spec

OptionalexclusiveMaximum

exclusiveMaximum?: number

exclusiveMaximum in JSON schema spec

OptionalexclusiveMinimum

exclusiveMinimum?: number

exclusiveMinimum in JSON schema spec

Optionalformat

format?: string

format in JSON schema spec

Optionalif

if?: boolean | JSONSchema

if in JSON schema spec

Optionalitems

items?: boolean | JSONSchema | (boolean | JSONSchema)[]

items in JSON schema spec

OptionalmaxContains

maxContains?: number

maxContains in JSON schema spec

Optionalmaximum

maximum?: number

maximum in JSON schema spec

OptionalmaxItems

maxItems?: number

maxItems in JSON schema spec

OptionalmaxLength

maxLength?: number

maxLength in JSON schema spec

OptionalmaxProperties

maxProperties?: number

maxProperties in JSON schema spec

OptionalminContains

minContains?: number

minContains in JSON schema spec

Optionalminimum

minimum?: number

minimum in JSON schema spec

OptionalminItems

minItems?: number

minItems in JSON schema spec

OptionalminLength

minLength?: number

minLength in JSON schema spec

OptionalminProperties

minProperties?: number

minProperties in JSON schema spec

OptionalmultipleOf

multipleOf?: number

multipleOf in JSON schema spec

Optionalnot

not?: boolean | JSONSchema

not in JSON schema spec

OptionaloneOf

oneOf?: (boolean | JSONSchema)[]

oneOf in JSON schema spec

Optionalpattern

pattern?: string

pattern in JSON schema spec

OptionalpatternProperties

patternProperties?: Dict<boolean | JSONSchema>

patternProperties in JSON schema spec

OptionalprefixItems

prefixItems?: (boolean | JSONSchema)[]

prefixItems in JSON schema spec

Optionalproperties

properties?: Dict<boolean | JSONSchema>

properties in JSON schema spec

OptionalpropertyNames

propertyNames?: boolean | JSONSchema

propertyNames in JSON schema spec

OptionalreadOnly

readOnly?: boolean

readOnly in JSON schema spec

Optionalrequired

required?: string[]

required in JSON schema spec

Optionalthen

then?: boolean | JSONSchema

then in JSON schema spec

Optionaltitle

title?: string

title in JSON schema spec

Optionaltype

type?: JSONSchemaType | JSONSchemaType[]

type in JSON schema spec

OptionalunevaluatedItems

unevaluatedItems?: boolean | JSONSchema

unevaluatedItems in JSON schema spec

OptionalunevaluatedProperties

unevaluatedProperties?: boolean | JSONSchema

unevaluatedProperties in JSON schema spec

OptionaluniqueItems

uniqueItems?: boolean

uniqueItems in JSON schema spec

OptionalwriteOnly

writeOnly?: boolean

writeOnly in JSON schema spec

Settings

Member Visibility

On This Page

Properties