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

OpenSpec2 and OpenSpec3 interfaces declarations for TypeScript application

export interface OS3Example {
    /**
     * Short description for the example.
     */
    summary?: string;
    /**
     * Long description for the example. CommonMark syntax MAY be used for rich text representation.
     */
    description?: string;
    /**
     * 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.
     */
    value?: any;
    /**
     * 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.
     */
    externalValue?: string;
}