# Interface OpenSpecExternalDocs

Interface
Module
import { OpenSpecExternalDocs } from "@tsed/openspec"
Source/packages/specs/openspec/src/types/common/OpenSpecExternalDocs.ts

# Overview

interface OpenSpecExternalDocs {
url<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>

description?<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>

}

# Members

url: string;

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


description?: string;

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