OpenSpecServerVariable

@tsed/openspec

Usage

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

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

Overview

interface OpenSpecServerVariable {
    enum?: string;
    default: string;
    description?: string;
}

enum

enum?: string;

An enumeration of string values to be used if the substitution options are from a limited set.

default

default: string;

The default value to use for substitution, and to send, if an alternate value is not supplied. Unlike the Schema Object's default, this value MUST be provided by the consumer.

description

description?: string;

An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.