Interface BaseSchemaObject

Hierarchy

Properties

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

Properties

Optional additionalProperties

additionalProperties?: boolean | OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject

Optional allOf

allOf?: (OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject)[]

Optional anyOf

anyOf?: (OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject)[]

Optional default

default?: any

Optional deprecated

deprecated?: boolean

Optional description

description?: string

Optional discriminator

discriminator?: OpenAPIV3.DiscriminatorObject

Optional enum

enum?: any[]

Optional example

example?: any

Optional exclusiveMaximum

exclusiveMaximum?: boolean

Optional exclusiveMinimum

exclusiveMinimum?: boolean

Optional externalDocs

externalDocs?: OpenAPIV3.ExternalDocumentationObject

Optional format

format?: 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?: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject

Optional nullable

nullable?: boolean

Optional oneOf

oneOf?: (OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject)[]

Optional pattern

pattern?: string

Optional properties

properties?: {
    [name: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject;
}

Type declaration

Optional readOnly

readOnly?: boolean

Optional required

required?: string[]

Optional title

title?: string

Optional uniqueItems

uniqueItems?: boolean

Optional writeOnly

writeOnly?: boolean

Optional xml

xml?: OpenAPIV3.XMLObject

Settings

Member Visibility

Theme

Generated using TypeDoc