Interface OS3Response

# Interface OS3Response

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

# Overview

interface OS3Response<Schema = OS3Schema, Header = OS3Header<Schema>> {

description<span class="token punctuation">:</span> <span class="token keyword">string</span><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/schema/types/decorators/operations/Header.html"><span class="token">Header</span></a>&gt;<span class="token punctuation">;</span>

content?<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/openspec3/OS3MediaType.html"><span class="token">OS3MediaType</span></a>&lt;<a href="/api/orm/mongoose/types/decorators/Schema.html"><span class="token">Schema</span></a>&gt;&gt;<span class="token punctuation">;</span>

links?<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/openspec3/OS3Link.html"><span class="token">OS3Link</span></a> | <a href="/api/specs/openspec/types/common/OpenSpecRef.html"><span class="token">OpenSpecRef</span></a>&gt;<span class="token punctuation">;</span>

}

# Members

description: string;

A short description of the response. CommonMark syntax MAY be used for rich text representation.

headers?: OpenSpecHash<Header>;

Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is defined with the name "Content-Type", it SHALL be ignored.

content?: OpenSpecHash<OS3MediaType<Schema>>;

A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*

links?: OpenSpecHash<OS3Link | OpenSpecRef>;

A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects.