Interface JSONSchema

interface JSONSchema {
    $comment?: string;
    $id?: string;
    $ref?: string;
    $schema?: string;
    additionalItems?: JSONSchemaRef;
    additionalProperties?: JSONSchemaRef;
    allOf?: JSONSchemaRef[];
    allowComments?: boolean;
    allowTrailingCommas?: boolean;
    anyOf?: JSONSchemaRef[];
    const?: any;
    contains?: JSONSchemaRef;
    default?: any;
    defaultSnippets?: {
        body?: any;
        bodyText?: string;
        description?: string;
        label?: string;
        markdownDescription?: string;
    }[];
    definitions?: {
        [name: string]: JSONSchema;
    };
    dependencies?: JSONSchemaMap | {
        [prop: string]: string[];
    };
    deprecationMessage?: string;
    description?: string;
    doNotSuggest?: boolean;
    else?: JSONSchemaRef;
    enum?: any[];
    enumDescriptions?: string[];
    errorMessage?: string;
    examples?: any[];
    exclusiveMaximum?: number | boolean;
    exclusiveMinimum?: number | boolean;
    format?: string;
    id?: string;
    if?: JSONSchemaRef;
    items?: JSONSchemaRef | JSONSchemaRef[];
    markdownDescription?: string;
    markdownEnumDescriptions?: string[];
    maxItems?: number;
    maxLength?: number;
    maxProperties?: number;
    maximum?: number;
    minItems?: number;
    minLength?: number;
    minProperties?: number;
    minimum?: number;
    multipleOf?: number;
    not?: JSONSchemaRef;
    oneOf?: JSONSchemaRef[];
    pattern?: string;
    patternErrorMessage?: string;
    patternProperties?: JSONSchemaMap;
    properties?: JSONSchemaMap;
    propertyNames?: JSONSchemaRef;
    required?: string[];
    suggestSortText?: string;
    then?: JSONSchemaRef;
    title?: string;
    type?: string | string[];
    uniqueItems?: boolean;
}

Properties

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

Properties

Optional $comment

$comment?: string

Optional $id

$id?: string

Optional $ref

$ref?: string

Optional $schema

$schema?: string

Optional additionalItems

additionalItems?: JSONSchemaRef

Optional additionalProperties

additionalProperties?: JSONSchemaRef

Optional allOf

allOf?: JSONSchemaRef[]

Optional allowComments

allowComments?: boolean

Optional allowTrailingCommas

allowTrailingCommas?: boolean

Optional anyOf

anyOf?: JSONSchemaRef[]

Optional const

const?: any

Optional contains

contains?: JSONSchemaRef

Optional default

default?: any

Optional defaultSnippets

defaultSnippets?: {
    body?: any;
    bodyText?: string;
    description?: string;
    label?: string;
    markdownDescription?: string;
}[]

Type declaration

  • Optional body?: any
  • Optional bodyText?: string
  • Optional description?: string
  • Optional label?: string
  • Optional markdownDescription?: string

Optional definitions

definitions?: {
    [name: string]: JSONSchema;
}

Type declaration

Optional dependencies

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

Type declaration

  • [prop: string]: string[]

Optional deprecationMessage

deprecationMessage?: string

Optional description

description?: string

Optional doNotSuggest

doNotSuggest?: boolean

Optional else

else?: JSONSchemaRef

Optional enum

enum?: any[]

Optional enumDescriptions

enumDescriptions?: string[]

Optional errorMessage

errorMessage?: string

Optional examples

examples?: any[]

Optional exclusiveMaximum

exclusiveMaximum?: number | boolean

Optional exclusiveMinimum

exclusiveMinimum?: number | boolean

Optional format

format?: string

Optional id

id?: string

Optional if

if?: JSONSchemaRef

Optional items

items?: JSONSchemaRef | JSONSchemaRef[]

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?: JSONSchemaRef

Optional oneOf

oneOf?: JSONSchemaRef[]

Optional pattern

pattern?: string

Optional patternErrorMessage

patternErrorMessage?: string

Optional patternProperties

patternProperties?: JSONSchemaMap

Optional properties

properties?: JSONSchemaMap

Optional propertyNames

propertyNames?: JSONSchemaRef

Optional required

required?: string[]

Optional suggestSortText

suggestSortText?: string

Optional then

then?: JSONSchemaRef

Optional title

title?: string

Optional type

type?: string | string[]

Optional uniqueItems

uniqueItems?: boolean

Settings

Member Visibility

Theme

On This Page

$comment$id$ref$schemaadditionalItemsadditionalPropertiesallOfallowCommentsallowTrailingCommasanyOfconstcontainsdefaultdefaultSnippetsdefinitionsdependenciesdeprecationMessagedescriptiondoNotSuggestelseenumenumDescriptionserrorMessageexamplesexclusiveMaximumexclusiveMinimumformatidifitemsmarkdownDescriptionmarkdownEnumDescriptionsmaxItemsmaxLengthmaxPropertiesmaximumminItemsminLengthminPropertiesminimummultipleOfnotoneOfpatternpatternErrorMessagepatternPropertiespropertiespropertyNamesrequiredsuggestSortTextthentitletypeuniqueItems