OasServerVariable

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

Members

Variables

default_
string default_;

**REQUIRED**. 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 OasSchema object's treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value SHOULD exist in the enum's values.

description
string description;

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

enum_
string[] enum_;

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

See Also

Meta