Class OpenapiV3Schema

OpenAPI 3.0 -> 3.0.4 schema model

Based on Draft 6, but with restricted keywords and definitions Modifications

  • type, cannot be an array nor contain 'null'

Restrictions (keywords not allowed)

  • patternProperties
  • not

https://swagger.io/specification/#schema-object

Indexable

[k: string]: any

Constructors

constructor

Properties

$id? $ref? $schema? additionalItems? additionalProperties? allOf? anyOf? const? contains? contentEncoding? contentMediaType? default? definitions? dependencies? deprecated? description? discriminator? enum? example? examples? exclusiveMaximum? exclusiveMinimum? externalDocs? format? items? maxItems? maxLength? maxProperties? maximum? minItems? minLength? minProperties? minimum? multipleOf? nullable? oneOf? pattern? properties? propertyNames? readOnly? required? title? type? uniqueItems? writeOnly? xml?

Methods

internalToSchema toSchema

Constructors

constructor

Properties

Optional $id

$id?: string

Optional $ref

$ref?: string

Optional $schema

$schema?: string

Optional additionalItems

additionalItems?: boolean | OpenapiV3Schema

Optional additionalProperties

additionalProperties?: boolean | OpenapiV3Schema

Optional allOf

allOf?: (boolean | OpenapiV3Schema)[]

Optional anyOf

anyOf?: (boolean | OpenapiV3Schema)[]

Optional const

const?: any

Optional contains

contains?: boolean | OpenapiV3Schema

Optional contentEncoding

contentEncoding?: string

Optional contentMediaType

contentMediaType?: string

Optional default

default?: any

Optional definitions

definitions?: {
    [key: string]: OpenapiV3Schema | boolean;
}

Type declaration

Optional dependencies

dependencies?: {
    [key: string]: OpenapiV3Schema | boolean | string[];
}

Type declaration

Optional deprecated

deprecated?: boolean

Optional description

description?: string

Optional discriminator

discriminator?: OpenapiV3Discriminator

Optional enum

enum?: any[]

Optional example

example?: any

Optional examples

examples?: any

Optional exclusiveMaximum

exclusiveMaximum?: number | boolean

Optional exclusiveMinimum

exclusiveMinimum?: number | boolean

Optional externalDocs

externalDocs?: OpenAPIV3ExternalDocumentation

Optional format

format?: string

Optional items

items?: boolean | OpenapiV3Schema | OpenapiV3Schema[]

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 oneOf

oneOf?: (boolean | OpenapiV3Schema)[]

Optional pattern

pattern?: string

Optional properties

properties?: {
    [key: string]: OpenapiV3Schema | boolean;
}

Type declaration

Optional propertyNames

propertyNames?: boolean | OpenapiV3Schema

Optional readOnly

readOnly?: boolean

Optional required

required?: string[]

Optional title

title?: string

Optional type

type?: string | string[]

Optional uniqueItems

uniqueItems?: boolean

Optional writeOnly

writeOnly?: boolean

Optional xml

xml?: OpenapiV3Xml

Methods

Static Private internalToSchema

Static toSchema

Settings

Member Visibility

Theme

On This Page

constructor$id$ref$schemaadditionalItemsadditionalPropertiesallOfanyOfconstcontainscontentEncodingcontentMediaTypedefaultdefinitionsdependenciesdeprecateddescriptiondiscriminatorenumexampleexamplesexclusiveMaximumexclusiveMinimumexternalDocsformatitemsmaxItemsmaxLengthmaxPropertiesmaximumminItemsminLengthminPropertiesminimummultipleOfnullableoneOfpatternpropertiespropertyNamesreadOnlyrequiredtitletypeuniqueItemswriteOnlyxmlinternalToSchematoSchema