# Interface OS3Example
InterfaceModule | import { OS3Example } from "@tsed/openspec" |
---|---|
Source | /packages/specs/openspec/src/types/openspec3/OS3Example.ts |
# Overview
interface OS3Example {
summary?<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>
value?<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">;</span>
externalValue?<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>
}
# Members
summary?: string;
Short description for the example.
description?: string;
Long description for the example. CommonMark syntax MAY be used for rich text representation.
value?: any;
Embedded literal example. The value
field and externalValue
field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary.
externalValue?: string;
A URL that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents.
The value
field and externalValue
field are mutually exclusive.