OpenSpecExternalDocs

@tsed/openspec

Usage

typescript

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

See /packages/specs/openspec/src/types/common/OpenSpecExternalDocs.ts.

Overview

ts

interface OpenSpecExternalDocs {
    url: string;
    description?: string;
}

url

ts

url: string;

The URL for the target documentation. Value MUST be in the format of a URL.

description

ts

description?: string;

A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.