OS3Example

@tsed/openspec

Usage

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

See /packages/specs/openspec/src/types/openspec3/OS3Example.ts.

Overview

interface OS3Example {
    summary?: string;
    description?: string;
    value?: any;
    externalValue?: string;
}

summary

summary?: string;

Short description for the example.

description

description?: string;

Long description for the example. CommonMark syntax MAY be used for rich text representation.

value

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

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.