Interface IResponseBody

Response body for an API operation.

Content-type is always application/json. For file downloads, use a URI string property instead of application/octet-stream.

interface IResponseBody {
description: string;
typeName: string;
}

Properties

description: string

Description of the response body.

MUST be written in English. Never use other languages.

typeName: string

Type name referencing a component schema.

Naming convention: IEntityName (full), IEntityName.ISummary, IEntityName.IInvert, IPageIEntityName (paginated).