Skip to main content

SwaggerSchema

Api Code Documentation / Exports / httpd/schema / SwaggerSchema

httpd/schema.SwaggerSchema

Hierarchy

  • FastifySchema

    SwaggerSchema

Table of contents

Properties

Properties

body

Optional body: unknown

Inherited from

FastifySchema.body

Defined in

node_modules/fastify/types/schema.d.ts:11


consumes

Optional consumes: string[]

Overrides

FastifySchema.consumes

Defined in

src/httpd/schema.ts:8


deprecated

Optional deprecated: boolean

Inherited from

FastifySchema.deprecated

Defined in

node_modules/@fastify/swagger/index.d.ts:36


description

description: string

Overrides

FastifySchema.description

Defined in

src/httpd/schema.ts:4


externalDocs

Optional externalDocs: ExternalDocumentationObject | ExternalDocumentationObject

Inherited from

FastifySchema.externalDocs

Defined in

node_modules/@fastify/swagger/index.d.ts:42


headers

Optional headers: unknown

Inherited from

FastifySchema.headers

Defined in

node_modules/fastify/types/schema.d.ts:14


hide

Optional hide: boolean

Inherited from

FastifySchema.hide

Defined in

node_modules/@fastify/swagger/index.d.ts:35


operationId

Optional operationId: string

OpenAPI operation unique identifier

Inherited from

FastifySchema.operationId

Defined in

node_modules/@fastify/swagger/index.d.ts:47


params

Optional params: unknown

Inherited from

FastifySchema.params

Defined in

node_modules/fastify/types/schema.d.ts:13


produces

Optional produces: readonly string[]

Inherited from

FastifySchema.produces

Defined in

node_modules/@fastify/swagger/index.d.ts:41


querystring

Optional querystring: unknown

Inherited from

FastifySchema.querystring

Defined in

node_modules/fastify/types/schema.d.ts:12


response

Optional response: unknown

Inherited from

FastifySchema.response

Defined in

node_modules/fastify/types/schema.d.ts:15


security

Optional security: { [securityLabel: string]: string[]; }[]

Overrides

FastifySchema.security

Defined in

src/httpd/schema.ts:7


summary

summary: string

Overrides

FastifySchema.summary

Defined in

src/httpd/schema.ts:6


tags

tags: string[]

Overrides

FastifySchema.tags

Defined in

src/httpd/schema.ts:5