OS3Response

@tsed/openspec

Usage

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

See /packages/specs/openspec/src/types/openspec3/OS3Response.ts.

Overview

interface OS3Response<Schema = OS3Schema, Header = OS3Header<Schema>> {
    description: string;
    headers?: OpenSpecHash<Header>;
    content?: OpenSpecHash<OS3MediaType<Schema>>;
    links?: OpenSpecHash<OS3Link | OpenSpecRef>;
}

description

description: string;

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

headers

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

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

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.