OptionaladditionalProperties
additionalProperties?: AdditionalProperties
Optionaldefault
default?: unknown
Optionaldeprecated
deprecated?: boolean
Optionaldescription
description?: string
Optionaldiscriminator
discriminator?: DiscriminatorObject
Optionalenum
enum?: unknown[]
Optionalexample
example?: unknown
OptionalexclusiveMaximum
exclusiveMaximum?: boolean
OptionalexclusiveMinimum
exclusiveMinimum?: boolean
OptionalexternalDocs
externalDocs?: ExternalDocObject
Optionalformat
format?: 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
Optionalnullable
nullable?: boolean
Optionalpattern
pattern?: string | RegExp
Optionalproperties
properties?: Record<string, ReferenceObject | SchemaObject | ISchemaShape> OptionalreadOnly
readOnly?: boolean
Optionalrequired
required?: string[]
Optionaltitle
title?: string
Optionaltype
type?: string
OptionaluniqueItems
uniqueItems?: boolean
OptionalwriteOnly
writeOnly?: boolean
CommonMark syntax MAY be used for rich text representation.