schemaobject.md

fastify-oas

Globals / SchemaObject

Interface: SchemaObject

Hierarchy

• ISpecificationExtension

  ↳ SchemaObject

Indexable

▪ [extensionName: string]: any

Index

Properties

• additionalProperties
• allOf
• anyOf
• default
• deprecated
• description
• discriminator
• enum
• example
• examples
• exclusiveMaximum
• exclusiveMinimum
• externalDocs
• format
• items
• maxItems
• maxLength
• maxProperties
• maximum
• minItems
• minLength
• minProperties
• minimum
• multipleOf
• not
• nullable
• oneOf
• pattern
• properties
• readOnly
• required
• title
• type
• uniqueItems
• writeOnly
• xml

Properties

additionalProperties

• Optional additionalProperties: SchemaObject | ReferenceObject | boolean

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:233

---

allOf

• Optional allOf: (SchemaObject | ReferenceObject)[]

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:225

---

anyOf

• Optional anyOf: (SchemaObject | ReferenceObject)[]

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:227

---

default

• Optional default: any

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:236

---

deprecated

• Optional deprecated: boolean

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:223

---

description

• Optional description: string

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:234

---

discriminator

• Optional discriminator: DiscriminatorObject

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:216

---

enum

• Optional enum: any[]

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:252

---

example

• Optional example: any

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:221

---

examples

• Optional examples: any[]

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:222

---

exclusiveMaximum

• Optional exclusiveMaximum: boolean

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:240

---

exclusiveMinimum

• Optional exclusiveMinimum: boolean

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:242

---

externalDocs

• Optional externalDocs: ExternalDocumentationObject

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:220

---

format

• Optional format: string

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:235

---

items

• Optional items: SchemaObject | ReferenceObject

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:229

---

maxItems

• Optional maxItems: number

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:246

---

maxLength

• Optional maxLength: number

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:243

---

maxProperties

• Optional maxProperties: number

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:249

---

maximum

• Optional maximum: number

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:239

---

minItems

• Optional minItems: number

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:247

---

minLength

• Optional minLength: number

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:244

---

minProperties

• Optional minProperties: number

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:250

---

minimum

• Optional minimum: number

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:241

---

multipleOf

• Optional multipleOf: number

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:238

---

not

• Optional not: SchemaObject | ReferenceObject

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:228

---

nullable

• Optional nullable: boolean

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:215

---

oneOf

• Optional oneOf: (SchemaObject | ReferenceObject)[]

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:226

---

pattern

• Optional pattern: string

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:245

---

properties

• Optional properties: { [propertyName:string]: SchemaObject | ReferenceObject; }

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:230

---

readOnly

• Optional readOnly: boolean

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:217

---

required

• Optional required: string[]

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:251

---

title

• Optional title: string

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:237

---

type

• Optional type: string

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:224

---

uniqueItems

• Optional uniqueItems: boolean

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:248

---

writeOnly

• Optional writeOnly: boolean

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:218

---

xml

• Optional xml: XmlObject

Defined in node_modules/openapi3-ts/dist/model/OpenApi.d.ts:219