Interface SchemaObject

Hierarchy

Indexable

[index: string]: any

Properties

$ref? $schema? additionalItems? additionalProperties? allOf? anyOf? default? definitions? dependencies? description? discriminator? enum? example? exclusiveMaximum? exclusiveMinimum? externalDocs? id? items? maxItems? maxLength? maxProperties? maximum? minItems? minLength? minProperties? minimum? multipleOf? not? oneOf? pattern? patternProperties? properties? readOnly? required? title? type? uniqueItems? xml?

Properties

Optional $ref

$ref?: string

Optional $schema

$schema?: string

Optional additionalItems

additionalItems?: boolean | IJsonSchema

Optional additionalProperties

additionalProperties?: boolean | IJsonSchema

Optional allOf

allOf?: IJsonSchema[]

Optional anyOf

anyOf?: IJsonSchema[]

Optional default

default?: any

Optional definitions

definitions?: {
    [name: string]: IJsonSchema;
}

Type declaration

Optional dependencies

dependencies?: {
    [name: string]: IJsonSchema | string[];
}

Type declaration

Optional description

description?: string

Optional discriminator

discriminator?: string

Optional enum

enum?: any[]

Optional example

example?: any

Optional exclusiveMaximum

exclusiveMaximum?: boolean

Optional exclusiveMinimum

exclusiveMinimum?: boolean

Optional externalDocs

externalDocs?: OpenAPIV2.ExternalDocumentationObject

Optional id

id?: string

Optional items

items?: OpenAPIV2.ReferenceObject | ItemsObject

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

Optional oneOf

oneOf?: IJsonSchema[]

Optional pattern

pattern?: string

Optional patternProperties

patternProperties?: {
    [name: string]: IJsonSchema;
}

Type declaration

Optional properties

properties?: {
    [name: string]: OpenAPIV2.SchemaObject;
}

Type declaration

Optional readOnly

readOnly?: boolean

Optional required

required?: string[]

Optional title

title?: string

Optional type

type?: string | string[]

Optional uniqueItems

uniqueItems?: boolean

Optional xml

xml?: OpenAPIV2.XMLObject

Settings

Member Visibility

Theme

Generated using TypeDoc