OS2Response

@tsed/openspec

Usage

import { OS2Response } from "@tsed/openspec";

See /packages/specs/openspec/src/types/openspec2/OS2Response.ts.

Overview

interface OS2Response {
    description: string;
    schema?: OS2Schema;
    headers?: OpenSpecHash<OS2Header>;
    examples?: OpenSpecHash<{}>;
}

description

description: string;

A short description of the response. GFM syntax can be used for rich text representation.

schema

schema?: OS2Schema;

A definition of the response structure. It can be a primitive, an array or an object. If this field does not exist, it means no content is returned as part of the response. As an extension to the Schema Object, its root type value may also be "file". This SHOULD be accompanied by a relevant produces mime-type.

headers

headers?: OpenSpecHash<OS2Header>;

A list of headers that are sent with the response.

examples

examples?: OpenSpecHash<{}>;

An example of the response message.