Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ApiDescription

Hierarchy

  • ApiDescription

Index

Properties

Properties

Optional additionalConditions

additionalConditions: ApiDocComparator[]

description

description: string

Optional detailDescription

detailDescription: string

function

function: Function

method

method: "GET" | "PUT" | "POST" | "DELETE"

Optional queryParameters

queryParameters: ApiDocQueryParameters[]

Optional requestBody

requestBody: any

Optional requestHeaders

requestHeaders: any

Optional responseBody

responseBody: any

uri

uri: string