Interface OS3Header

Interface

Module	import { OS3Header } from "@tsed/openspec"
Source	/packages/specs/openspec/src/types/openspec3/OS3Header.ts

Overview

interface OS3Header<Schema = OS3Schema> {
description?<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>

schema?<span class="token punctuation">:</span> <a href="/api/orm/mongoose/types/decorators/Schema.html"><span class="token">Schema</span></a> | <a href="/api/specs/openspec/types/common/OpenSpecRef.html"><span class="token">OpenSpecRef</span></a><span class="token punctuation">;</span>

externalDocs?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/common/OpenSpecExternalDocs.html"><span class="token">OpenSpecExternalDocs</span></a><span class="token punctuation">;</span>
}

Members

description?: string;

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

---

schema?: Schema | OpenSpecRef;

The schema defining the type used for the header.

---

externalDocs?: OpenSpecExternalDocs;

Additional external documentation for this tag.