@tsed/openspec/lib/types/openspec3/OS3Header.d.ts

OpenSpec2 and OpenSpec3 interfaces declarations for TypeScript application

import { OpenSpecExternalDocs } from "../common/OpenSpecExternalDocs.js";
import { OpenSpecRef } from "../common/OpenSpecRef.js";
import { OS3Schema } from "./OS3Schema.js";
export interface OS3Header<Schema = OS3Schema> {
    /**
     * A description of the header. CommonMark syntax MAY be used for rich text representation.
     */
    description?: string;
    /**
     * The schema defining the type used for the header.
     */
    schema?: Schema | OpenSpecRef;
    /**
     * Additional external documentation for this tag.
     */
    externalDocs?: OpenSpecExternalDocs;
}