Aller au contenu principal
Version: Next

ApiPropertyOptions

Hierarchy

Index

Properties

Properties

optional$ref

$ref?: string

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[] | Record<string, any>

optionalenumName

enumName?: string

optionalexample

example?: any

optionalexamples

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

optionalexclusiveMaximum

exclusiveMaximum?: boolean

optionalexclusiveMinimum

exclusiveMinimum?: boolean

optionalexternalDocs

externalDocs?: ExternalDocumentationObject

optionalformat

format?: string

optionalisArray

isArray?: boolean

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

optionalname

name?: string

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

optionaltitle

title?: string

optionaltype

type?: string | Record<string, any> | Type<unknown> | [Type<any>]

optionaluniqueItems

uniqueItems?: boolean

optionalwriteOnly

writeOnly?: boolean

optionalxml

xml?: XmlObject