Share via


RestApiServerVariable Class

Definition

REST API server variable.

public sealed class RestApiServerVariable
type RestApiServerVariable = class
Public NotInheritable Class RestApiServerVariable
Inheritance
RestApiServerVariable

Properties

ArgumentName

The variable argument name. If provided, the argument name will be used to search for the corresponding variable value in function arguments. If no property value is found using the argument name, the original name represented by the Variables dictionary key will be used for the search instead.

Default

REQUIRED. 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

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

Enum

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

Methods

IsValid(String)

Return true if the value is valid based on the enumeration of string values to be used.

Applies to