Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Schema3

Hierarchy

  • Omit<Schema, "type">
    • Schema3

Index

Properties

Optional $ref

$ref: string

Optional additionalProperties

additionalProperties: boolean | BaseSchema

Optional allOf

allOf: BaseSchema[]

Optional anyOf

anyOf: BaseSchema[]

Optional default

default: any

Optional description

description: string

Optional discriminator

discriminator: string

Optional enum

enum: (null | string | number)[]

Optional example

example: unknown

Optional exclusiveMaximum

exclusiveMaximum: number

Optional exclusiveMinimum

exclusiveMinimum: number

Optional externalDocs

externalDocs: ExternalDocs

Optional format

format: "double" | "float" | "date" | "binary" | "byte" | "int32" | "int64" | "date-time" | "password"

Optional items

items: BaseSchema

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 nullable

nullable: boolean

Optional pattern

pattern: string

Optional properties

properties: {}

Type declaration

Optional readOnly

readOnly: boolean

Optional required

required: string[]

Optional title

title: string

Optional type

type: "string" | "number" | "boolean" | "object" | "file" | "integer" | "array"

Optional uniqueItems

uniqueItems: boolean

Optional x-enum-varnames

x-enum-varnames: string[]

Optional xml

xml: XML

Generated using TypeDoc