Interface IResponse

Response definition.

interface IResponse {
    description?: string;
    example?: any;
    headers?: Record<string, SwaggerV2.IJsonSchema>;
    schema?: SwaggerV2.IJsonSchema;
}

Index

Properties

description? example? headers? schema?

Properties

`Optional`description

description?: string

Response description.

`Optional`example

example?: any

Example value.

`Optional`headers

headers?: Record<string, SwaggerV2.IJsonSchema>

Response headers.

`Optional`schema

schema?: SwaggerV2.IJsonSchema

Response body schema.