_fastify_.routeschema.md

fastify-oas

Globals / "fastify" / RouteSchema

Interface: RouteSchema

Hierarchy

• RouteSchema

Index

Properties

• consumes
• description
• hide
• operationId
• produces
• security
• summary
• tags

Properties

consumes

• Optional consumes: Array<string>

Defined in lib/index.d.ts:45

Media types route consumes

---

description

• Optional description: string

Defined in lib/index.d.ts:33

Route description

---

hide

• Optional hide: boolean

Defined in lib/index.d.ts:29

Hides route from result OpenAPI document

default false

---

operationId

• Optional operationId: string

Defined in lib/index.d.ts:57

OpenAPI operation unique identifier

---

produces

• Optional produces: Array<string>

Defined in lib/index.d.ts:49

Media types route produces

---

security

• Optional security: Array<SecurityRequirementObject>

Defined in lib/index.d.ts:53

OpenAPI security definitions

---

summary

• Optional summary: string

Defined in lib/index.d.ts:37

Route summary

---

tags

• Optional tags: Array<string>

Defined in lib/index.d.ts:41

Route tags