Interface SwaggerV2PathDocBlock<TDetails>

A Swagger V2 documentation block for a path.

Type parameters

TDetails: object

Hierarchy

SwaggerV2DocBlock
- SwaggerV2PathDocBlock

Index

Properties

Properties

Optional description

description: string

The summary.

details

details: TDetails | false | null | undefined

The details.

jsDoc

jsDoc: Annotation

The underlying JSDoc annotation.

type

type: "path"

inheritdoc

Generated using TypeDoc