OS3Header

@tsed/openspec

Usage

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

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

Overview

interface OS3Header<Schema = OS3Schema> {
    description?: string;
    schema?: Schema | OpenSpecRef;
    externalDocs?: OpenSpecExternalDocs;
}

description

description?: string;

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

schema

schema?: Schema | OpenSpecRef;

The schema defining the type used for the header.

externalDocs

externalDocs?: OpenSpecExternalDocs;

Additional external documentation for this tag.