Interface OS2Response

# Interface OS2Response

Interface
Module
import { OS2Response } from "@tsed/openspec"
Source/packages/specs/openspec/src/types/openspec2/OS2Response.ts

# Overview

interface OS2Response {

description<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>

schema?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/openspec2/OS2Schema.html"><span class="token">OS2Schema</span></a><span class="token punctuation">;</span>

headers?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/common/OpenSpecHash.html"><span class="token">OpenSpecHash</span></a>&lt;<a href="/api/specs/openspec/types/openspec2/OS2Header.html"><span class="token">OS2Header</span></a>&gt;<span class="token punctuation">;</span>

examples?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/common/OpenSpecHash.html"><span class="token">OpenSpecHash</span></a>&lt;<span class="token punctuation">{</span><span class="token punctuation">}</span>&gt;<span class="token punctuation">;</span>

}

# Members

description: string;

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

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?: OpenSpecHash<OS2Header>;

A list of headers that are sent with the response.

examples?: OpenSpecHash<{}>;

An example of the response message.