Type alias RawDataRoute

RawDataRoute: {
    data: any;
    method: Method;
    path: string;
}

Fallback route for when raw swagger control is desired. The [data] field should be a javascript object that will be then included in the final swagger specification like so:

"paths": { [path]: { [method]: data } }

This value will be JSON.stringify'd as part of normal processing. It should not be passed as string here.

Type declaration

  • data: any
  • method: Method
  • path: string

    The path on the API that will return the provided [data]. If not prefixed with /, then a / will be added automatically to the beginning.

Settings

Member Visibility

Theme

Generated using TypeDoc