Class SwaggerV2Schema

OpenAPI 2.0 (Swagger 2.0) schema model

Based on Draft 4, but with restricted keywords and definitions

Restrictions (keywords not allowed)

  • oneOf
  • anyOf
  • patternProperties
  • not

https://swagger.io/specification/v2/#schemaObject

Indexable

[k: string]: any

Constructors

constructor

Properties

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

Methods

internalToSchema toSchema

Constructors

constructor

Properties

Optional $ref

$ref?: string

Optional $schema

$schema?: string

Optional additionalProperties

additionalProperties?: boolean | SwaggerV2Schema

Optional allOf

allOf?: SwaggerV2Schema[]

Optional default

default?: any

Optional definitions

definitions?: {
    [key: string]: SwaggerV2Schema;
}

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

Optional format

format?: string

Optional id

id?: string

Optional items

items?: SwaggerV2Schema | SwaggerV2Schema[]

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 pattern

pattern?: string

Optional properties

properties?: {
    [key: string]: SwaggerV2Schema;
}

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

Methods

Static Private internalToSchema

Static toSchema

Settings

Member Visibility

Theme

On This Page

constructor$ref$schemaadditionalPropertiesallOfdefaultdefinitionsdescriptiondiscriminatorenumexampleexclusiveMaximumexclusiveMinimumexternalDocsformatiditemsmaxItemsmaxLengthmaxPropertiesmaximumminItemsminLengthminPropertiesminimummultipleOfpatternpropertiesreadOnlyrequiredtitletypeuniqueItemsxmlinternalToSchematoSchema