SchemaObject

Index

Properties

• additionalProperties
• allOf
• anyOf
• default
• deprecated
• description
• discriminator
• enum
• example
• examples
• exclusiveMaximum
• exclusiveMinimum
• externalDocs
• format
• items
• maxItems
• maxLength
• maxProperties
• maximum
• minItems
• minLength
• minProperties
• minimum
• multipleOf
• not
• nullable
• oneOf
• pattern
• patternProperties
• properties
• readOnly
• required
• title
• type
• uniqueItems
• writeOnly
• xml

Properties

optionaladditionalProperties

additionalProperties?: boolean | SchemaObject | ReferenceObject

optionalallOf

allOf?: (SchemaObject | ReferenceObject)[]

optionalanyOf

anyOf?: (SchemaObject | ReferenceObject)[]

optionaldefault

default?: any

optionaldeprecated

deprecated?: boolean

optionaldescription

description?: string

optionaldiscriminator

discriminator?: DiscriminatorObject

optionalenum

enum?: any[]

optionalexample

example?: any

optionalexamples

examples?: any[] | Record<string, any>

optionalexclusiveMaximum

exclusiveMaximum?: boolean

optionalexclusiveMinimum

exclusiveMinimum?: boolean

optionalexternalDocs

externalDocs?: ExternalDocumentationObject

optionalformat

format?: string

optionalitems

items?: SchemaObject | ReferenceObject

optionalmaxItems

maxItems?: number

optionalmaxLength

maxLength?: number

optionalmaxProperties

maxProperties?: number

optionalmaximum

maximum?: number

optionalminItems

minItems?: number

optionalminLength

minLength?: number

optionalminProperties

minProperties?: number

optionalminimum

minimum?: number

optionalmultipleOf

multipleOf?: number

optionalnot

not?: SchemaObject | ReferenceObject

optionalnullable

nullable?: boolean

optionaloneOf

oneOf?: (SchemaObject | ReferenceObject)[]

optionalpattern

pattern?: string

optionalpatternProperties

patternProperties?: any

optionalproperties

properties?: Record<string, SchemaObject | ReferenceObject>

optionalreadOnly

readOnly?: boolean

optionalrequired

required?: string[]

optionaltitle

title?: string

optionaltype

type?: string | new (...args: any[]) => any | () => new (...args: any[]) => any

optionaluniqueItems

uniqueItems?: boolean

optionalwriteOnly

writeOnly?: boolean

optionalxml

xml?: XmlObject