Interface OpenSpecServerVariable

Interface

Module	import { OpenSpecServerVariable } from "@tsed/openspec"
Source	/packages/specs/openspec/src/types/openspec3/OS3Server.ts

Overview

interface OpenSpecServerVariable {
<span class="token keyword">enum</span>?<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>

default<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

enum?: string;

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

---

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?: string;

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