fastifyoas.openapispec.md

fastify-oas

Globals / fastifyOAS / OpenApiSpec

Interface: OpenApiSpec

Hierarchy

• OpenApiSpec

Index

Properties

• basePath
• components
• consumes
• externalDocs
• host
• info
• produces
• schemes
• security
• securityDefinitions
• servers
• tags
• x-tagGroups

Properties

basePath

• Optional basePath: string

Defined in lib/index.d.ts:66

---

components

• Optional components: ComponentsObject

Defined in lib/index.d.ts:75

---

consumes

• Optional consumes: Array<string>

Defined in lib/index.d.ts:69

---

externalDocs

• Optional externalDocs: ExternalDocumentationObject | ExternalDocs

Defined in lib/index.d.ts:64

---

host

• Optional host: string

Defined in lib/index.d.ts:65

---

info

• Optional info: InfoObject | Info

Defined in lib/index.d.ts:63

---

produces

• Optional produces: Array<string>

Defined in lib/index.d.ts:70

---

schemes

• Optional schemes: SchemasObject | Array<string>

Defined in lib/index.d.ts:68

---

security

• Optional security: Array<SecurityRequirementObject> | Array<{ [securityDefinitionName:string]: Array<string>; }>

Defined in lib/index.d.ts:71

---

securityDefinitions

• Optional securityDefinitions: { [securityDefinitionName:string]: Security; }

Defined in lib/index.d.ts:76

---

servers

• Optional servers: Array<Server>

Defined in lib/index.d.ts:74

---

tags

• Optional tags: Array<TagObject> | Array<Tag>

Defined in lib/index.d.ts:79

---

x-tagGroups

• Optional x-tagGroups: string

Defined in lib/index.d.ts:67