JsonRequestBody

@tsed/schema

Usage

import { JsonRequestBody } from "@tsed/schema";

See /packages/specs/schema/src/domain/JsonRequestBody.ts.

Overview

class JsonRequestBody extends JsonMap<JsonRequestBodyOptions> {
    $kind: string;
    constructor(obj?: Partial<JsonRequestBodyOptions>);
    description(description: string): this;
    content(content: OpenSpecHash<OS3MediaType<JsonSchema>>): this;
    addContent(mediaType: string, schema: JsonSchema, examples?: any): this;
    required(required: boolean): this;
}

$kind

$kind: string;

description

description(description: string): this;

content

content(content: OpenSpecHash<OS3MediaType<JsonSchema>>): this;

addContent

addContent(mediaType: string, schema: JsonSchema, examples?: any): this;

required

required(required: boolean): this;