OS3RequestBody

@tsed/openspec

Usage

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

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

Overview

interface OS3RequestBody<Schema = OS3Schema> {
    description?: string;
    content?: OpenSpecHash<OS3MediaType<Schema>>;
    required?: boolean;
    examples?: OpenSpecHash<OS3Example | OpenSpecRef>;
}

description

description?: string;

A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.

content

content?: OpenSpecHash<OS3MediaType<Schema>>;

A map containing descriptions of potential request body. 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/*

required

required?: boolean;

Determines if the request body is required in the request. Defaults to false.

examples

examples?: OpenSpecHash<OS3Example | OpenSpecRef>;