ServerVariable
in package
implements
OpenApiAttributeInterface
An object representing a Server Variable for server URL template substitution.
Interfaces, Classes, Traits and Enums
Table of Contents
- $allowableValues : array<string|int, mixed>
- $defaultValue : string
- $description : string
- $extensions : array<string|int, mixed>
- $name : string
- __construct() : mixed
Properties
$allowableValues
public
array<string|int, mixed>
$allowableValues
= []
$defaultValue
public
string
$defaultValue
$description
public
string
$description
= ""
$extensions
public
array<string|int, mixed>
$extensions
= []
$name
public
string
$name
Methods
__construct()
public
__construct(string $name, string $defaultValue[, array<string|int, string> $allowableValues = [] ][, string $description = "" ][, array<string|int, Extension> $extensions = [] ]) : mixed
Parameters
- $name : string
-
Required. The name of this variable.
- $defaultValue : string
-
Required. The default value of this variable.
- $allowableValues : array<string|int, string> = []
-
An array of allowable values for this variable. This field map to the enum property in the OAS schema.
- $description : string = ""
-
An optional description for the server variable.
- $extensions : array<string|int, Extension> = []
-
The list of optional extensions.