Skip to main content

ServerVariable

This class represents a variable for server URL templates, allowing for substitution of values within a base URL. It defines a default value, an optional description, and an optional list of enumerated strings to restrict the variable's possible values.

Attributes

AttributeTypeDescription
enum`list[str]None` = null
defaultstringThe default value to use for substitution, which must be one of the values defined in the enum if applicable.
description`stringNone` = null

Constructor

Signature

def ServerVariable(
enum: list[str]| None = None,
default: str,
description: str | None = None
) - > null

Parameters

NameTypeDescription
enum`list[str]None` = None
defaultstrThe default value to be used if no other value is provided.
description`strNone` = None

Signature

def ServerVariable(
enum: list[str]| None = None,
default: string = null,
description: string | None = None
) - > null

Parameters

NameTypeDescription
enum`list[str]None` = None
defaultstring = nullThe default value to use for substitution if an alternate value is not supplied.
description`stringNone` = None