OS3Components

@tsed/openspec

Usage

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

See /packages/specs/openspec/src/openspec3/OS3Components.ts.

Overview

interface OS3Components<Schema = OS3Schema> {
    schemas?: OpenSpecHash<Schema>;
    responses?: OpenSpecHash<OS3Response<Schema>>;
    parameters?: OpenSpecHash<OS3Parameter<Schema>>;
    examples?: OpenSpecHash<OS3Example>;
    requestBodies?: OpenSpecHash<OS3RequestBody<Schema>>;
    headers?: OpenSpecHash<OS3Header<Schema>>;
    securitySchemes?: OpenSpecHash<OS3Security>;
    links?: OpenSpecHash<OS3Link>;
    callbacks?: OS3Callbacks;
}

schemas

schemas?: OpenSpecHash<Schema>;

An object to hold reusable Schema Objects.

responses

responses?: OpenSpecHash<OS3Response<Schema>>;

An object to hold reusable Response Objects.

parameters

parameters?: OpenSpecHash<OS3Parameter<Schema>>;

An object to hold reusable Parameter Objects.

examples

examples?: OpenSpecHash<OS3Example>;

An object to hold reusable Example Objects.

requestBodies

requestBodies?: OpenSpecHash<OS3RequestBody<Schema>>;

An object to hold reusable Request Body Objects.

headers

headers?: OpenSpecHash<OS3Header<Schema>>;

An object to hold reusable Header Objects.

securitySchemes

securitySchemes?: OpenSpecHash<OS3Security>;

An object to hold reusable Security Scheme Objects.

links

links?: OpenSpecHash<OS3Link>;

An object to hold reusable Link Objects.

callbacks

callbacks?: OS3Callbacks;

An object to hold reusable Callback Objects.