Interface ServerVariableObject

An object representing a Server Variable for server URL template substitution.

See

https://spec.openapis.org/oas/latest.html#server-variable-object

interface ServerVariableObject {
    default: string;
    description?: string;
    enum?: string[];
}

Hierarchy (view full)

Properties

default description? enum?

Properties

default

default: string

The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object’s treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value MUST exist in the enum’s values.

Optional description

description?: string

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

Optional enum

enum?: string[]

An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty.

Settings

Member Visibility

Theme

On This Page

defaultdescriptionenum