Optional$comment
$comment?: string
Optional$ref
$ref?: string
Optional$schema
$schema?: string
OptionaladditionalProperties
OptionalallowComments
allowComments?: boolean
OptionalallowTrailingCommas
allowTrailingCommas?: boolean
Optionaldefault
default?: any
OptionaldefaultSnippets
defaultSnippets?: {
body?: any;
bodyText?: string;
description?: string;
label?: string;
markdownDescription?: string;
}[]
OptionaldeprecationMessage
deprecationMessage?: string
Optionaldescription
description?: string
OptionaldoNotSuggest
doNotSuggest?: boolean
OptionalenumDescriptions
enumDescriptions?: string[]
OptionalerrorMessage
errorMessage?: string
Optionalexamples
examples?: any[]
OptionalexclusiveMaximum
exclusiveMaximum?: number | boolean
OptionalexclusiveMinimum
exclusiveMinimum?: number | boolean
Optionalformat
format?: string
OptionalmarkdownDescription
markdownDescription?: string
OptionalmarkdownEnumDescriptions
markdownEnumDescriptions?: string[]
Optionalmaximum
maximum?: number
OptionalmaxItems
maxItems?: number
OptionalmaxLength
maxLength?: number
OptionalmaxProperties
maxProperties?: number
Optionalminimum
minimum?: number
OptionalminItems
minItems?: number
OptionalminLength
minLength?: number
OptionalminProperties
minProperties?: number
OptionalmultipleOf
multipleOf?: number
Optionalpattern
pattern?: string
OptionalpatternErrorMessage
patternErrorMessage?: string
OptionalpatternProperties
Optionalrequired
required?: string[]
OptionalsuggestSortText
suggestSortText?: string
Optionaltitle
title?: string
Optionaltype
type?: string | string[]
OptionaluniqueItems
uniqueItems?: boolean
A JSON schema.