schema.md

fastify-oas

Globals / Schema

Interface: Schema

Hierarchy

• { default?: any ; description?: string ; enum?: any[] ; exclusiveMaximum?: boolean ; exclusiveMinimum?: boolean ; format?: string ; items?: Schema | Schema[] ; maxItems?: number ; maxLength?: number ; maxProperties?: number ; maximum?: number ; minItems?: number ; minLength?: number ; minProperties?: number ; minimum?: number ; multipleOf?: number ; pattern?: string ; title?: string ; type?: ParameterType ; uniqueItems?: boolean }

  ↳ Schema

Index

Properties

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

Properties

$ref

• Optional $ref: string

Defined in node_modules/@types/swagger-schema-official/index.d.ts:177

---

additionalProperties

• Optional additionalProperties: Schema | boolean

Defined in node_modules/@types/swagger-schema-official/index.d.ts:179

---

allOf

• Optional allOf: Schema[]

Defined in node_modules/@types/swagger-schema-official/index.d.ts:178

---

default

• Optional default: any

Inherited from __type.default

Defined in node_modules/@types/swagger-schema-official/index.d.ts:158

---

description

• Optional description: string

Inherited from __type.description

Defined in node_modules/@types/swagger-schema-official/index.d.ts:157

---

discriminator

• Optional discriminator: string

Defined in node_modules/@types/swagger-schema-official/index.d.ts:181

---

enum

• Optional enum: any[]

Inherited from __type.enum

Defined in node_modules/@types/swagger-schema-official/index.d.ts:172

---

example

• Optional example: any

Defined in node_modules/@types/swagger-schema-official/index.d.ts:185

---

exclusiveMaximum

• Optional exclusiveMaximum: boolean

Inherited from __type.exclusiveMaximum

Defined in node_modules/@types/swagger-schema-official/index.d.ts:161

---

exclusiveMinimum

• Optional exclusiveMinimum: boolean

Inherited from __type.exclusiveMinimum

Defined in node_modules/@types/swagger-schema-official/index.d.ts:163

---

externalDocs

• Optional externalDocs: ExternalDocs

Defined in node_modules/@types/swagger-schema-official/index.d.ts:184

---

format

• Optional format: string

Inherited from __type.format

Defined in node_modules/@types/swagger-schema-official/index.d.ts:155

---

items

• Optional items: Schema | Schema[]

Inherited from __type.items

Defined in node_modules/@types/swagger-schema-official/index.d.ts:173

---

maxItems

• Optional maxItems: number

Inherited from __type.maxItems

Defined in node_modules/@types/swagger-schema-official/index.d.ts:167

---

maxLength

• Optional maxLength: number

Inherited from __type.maxLength

Defined in node_modules/@types/swagger-schema-official/index.d.ts:164

---

maxProperties

• Optional maxProperties: number

Inherited from __type.maxProperties

Defined in node_modules/@types/swagger-schema-official/index.d.ts:170

---

maximum

• Optional maximum: number

Inherited from __type.maximum

Defined in node_modules/@types/swagger-schema-official/index.d.ts:160

---

minItems

• Optional minItems: number

Inherited from __type.minItems

Defined in node_modules/@types/swagger-schema-official/index.d.ts:168

---

minLength

• Optional minLength: number

Inherited from __type.minLength

Defined in node_modules/@types/swagger-schema-official/index.d.ts:165

---

minProperties

• Optional minProperties: number

Inherited from __type.minProperties

Defined in node_modules/@types/swagger-schema-official/index.d.ts:171

---

minimum

• Optional minimum: number

Inherited from __type.minimum

Defined in node_modules/@types/swagger-schema-official/index.d.ts:162

---

multipleOf

• Optional multipleOf: number

Inherited from __type.multipleOf

Defined in node_modules/@types/swagger-schema-official/index.d.ts:159

---

pattern

• Optional pattern: string

Inherited from __type.pattern

Defined in node_modules/@types/swagger-schema-official/index.d.ts:166

---

properties

• Optional properties: { [propertyName:string]: Schema; }

Defined in node_modules/@types/swagger-schema-official/index.d.ts:180

---

readOnly

• Optional readOnly: boolean

Defined in node_modules/@types/swagger-schema-official/index.d.ts:182

---

required

• Optional required: string[]

Defined in node_modules/@types/swagger-schema-official/index.d.ts:186

---

title

• Optional title: string

Inherited from __type.title

Defined in node_modules/@types/swagger-schema-official/index.d.ts:156

---

type

• Optional type: ParameterType

Inherited from __type.type

Defined in node_modules/@types/swagger-schema-official/index.d.ts:154

---

uniqueItems

• Optional uniqueItems: boolean

Inherited from __type.uniqueItems

Defined in node_modules/@types/swagger-schema-official/index.d.ts:169

---

xml

• Optional xml: XML

Defined in node_modules/@types/swagger-schema-official/index.d.ts:183