Interface IJSONSchema

extended JSON schema

interface IJSONSchema {
    $comment?: string;
    $id?: string;
    $ref?: string;
    $schema?: string;
    additionalItems?: boolean | IJSONSchema;
    additionalProperties?: boolean | IJSONSchema;
    allOf?: IJSONSchema[];
    allowComments?: boolean;
    allowTrailingCommas?: boolean;
    anyOf?: IJSONSchema[];
    const?: JSONValue;
    contains?: IJSONSchema;
    default?: JSONValue;
    defaultSnippets?: IJSONSchemaSnippet[];
    definitions?: IJSONSchemaMap;
    dependencies?: IJSONSchemaMap | {
        [prop: string]: string[];
    };
    deprecationMessage?: string;
    description?: string;
    doNotSuggest?: boolean;
    else?: IJSONSchema;
    enum?: JSONValue[];
    enumDescriptions?: string[];
    enumItemLabels?: string[];
    errorMessage?: string;
    exclusiveMaximum?: number | boolean;
    exclusiveMinimum?: number | boolean;
    format?: string;
    group?: string;
    id?: string;
    if?: IJSONSchema;
    items?: IJSONSchema | IJSONSchema[];
    markdownDescription?: string;
    markdownEnumDescriptions?: string[];
    maxItems?: number;
    maxLength?: number;
    maxProperties?: number;
    maximum?: number;
    minItems?: number;
    minLength?: number;
    minProperties?: number;
    minimum?: number;
    multipleOf?: number;
    not?: IJSONSchema;
    oneOf?: IJSONSchema[];
    owner?: string;
    pattern?: string;
    patternErrorMessage?: string;
    patternProperties?: IJSONSchemaMap;
    prefixItems?: IJSONSchema[];
    properties?: IJSONSchemaMap;
    propertyNames?: IJSONSchema;
    required?: string[];
    then?: IJSONSchema;
    title?: string;
    type?: JsonType | JsonType[];
    uniqueItems?: boolean;
}

Hierarchy (view full)

Properties

$comment? $id? $ref? $schema? additionalItems? additionalProperties? allOf? allowComments? allowTrailingCommas? anyOf? const? contains? default? defaultSnippets? definitions? dependencies? deprecationMessage? description? doNotSuggest? else? enum? enumDescriptions? enumItemLabels? errorMessage? exclusiveMaximum? exclusiveMinimum? format? group? id? if? items? markdownDescription? markdownEnumDescriptions? maxItems? maxLength? maxProperties? maximum? minItems? minLength? minProperties? minimum? multipleOf? not? oneOf? owner? pattern? patternErrorMessage? patternProperties? prefixItems? properties? propertyNames? required? then? title? type? uniqueItems?

Properties

Optional $comment

$comment?: string

Optional $id

$id?: string

Optional $ref

$ref?: string

Optional $schema

$schema?: string

Optional additionalItems

additionalItems?: boolean | IJSONSchema

Optional additionalProperties

additionalProperties?: boolean | IJSONSchema

Optional allOf

allOf?: IJSONSchema[]

Optional allowComments

allowComments?: boolean

Optional allowTrailingCommas

allowTrailingCommas?: boolean

Optional anyOf

anyOf?: IJSONSchema[]

Optional const

const?: JSONValue

Optional contains

contains?: IJSONSchema

Optional default

default?: JSONValue

Optional defaultSnippets

defaultSnippets?: IJSONSchemaSnippet[]

Optional definitions

definitions?: IJSONSchemaMap

Optional dependencies

dependencies?: IJSONSchemaMap | {
    [prop: string]: string[];
}

Type declaration

  • [prop: string]: string[]

Optional deprecationMessage

deprecationMessage?: string

Optional description

description?: string

Optional doNotSuggest

doNotSuggest?: boolean

Optional else

else?: IJSONSchema

Optional enum

enum?: JSONValue[]

Optional enumDescriptions

enumDescriptions?: string[]

Optional enumItemLabels

enumItemLabels?: string[]

Optional errorMessage

errorMessage?: string

Optional exclusiveMaximum

exclusiveMaximum?: number | boolean

Optional exclusiveMinimum

exclusiveMinimum?: number | boolean

Optional format

format?: string

Optional group

group?: string

Optional id

id?: string

Optional if

if?: IJSONSchema

Optional items

items?: IJSONSchema | IJSONSchema[]

Optional markdownDescription

markdownDescription?: string

Optional markdownEnumDescriptions

markdownEnumDescriptions?: string[]

Optional maxItems

maxItems?: number

Optional maxLength

maxLength?: number

Optional maxProperties

maxProperties?: number

Optional maximum

maximum?: number

Optional minItems

minItems?: number

Optional minLength

minLength?: number

Optional minProperties

minProperties?: number

Optional minimum

minimum?: number

Optional multipleOf

multipleOf?: number

Optional not

not?: IJSONSchema

Optional oneOf

oneOf?: IJSONSchema[]

Optional owner

owner?: string

Optional pattern

pattern?: string

Optional patternErrorMessage

patternErrorMessage?: string

Optional patternProperties

patternProperties?: IJSONSchemaMap

Optional prefixItems

prefixItems?: IJSONSchema[]

Optional properties

properties?: IJSONSchemaMap

Optional propertyNames

propertyNames?: IJSONSchema

Optional required

required?: string[]

Optional then

then?: IJSONSchema

Optional title

title?: string

Optional type

type?: JsonType | JsonType[]

Optional uniqueItems

uniqueItems?: boolean

Settings

Member Visibility

Theme

On This Page

$comment$id$ref$schemaadditionalItemsadditionalPropertiesallOfallowCommentsallowTrailingCommasanyOfconstcontainsdefaultdefaultSnippetsdefinitionsdependenciesdeprecationMessagedescriptiondoNotSuggestelseenumenumDescriptionsenumItemLabelserrorMessageexclusiveMaximumexclusiveMinimumformatgroupidifitemsmarkdownDescriptionmarkdownEnumDescriptionsmaxItemsmaxLengthmaxPropertiesmaximumminItemsminLengthminPropertiesminimummultipleOfnotoneOfownerpatternpatternErrorMessagepatternPropertiesprefixItemspropertiespropertyNamesrequiredthentitletypeuniqueItems