ServerVariable (swagger-annotations 2.2.20 API)

@Target({})
@Retention(RUNTIME)
@Inherited
public @interface ServerVariable

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

Required Element Summary

Required Elements
Modifier and Type Required Element Description

String defaultValue
Required.

String name
Required.

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element	Description
`String[]`	`allowableValues`	An array of allowable values for this variable.
`String`	`description`	An optional description for the server variable.
`Extension[]`	`extensions`	The list of optional extensions

- Element Detail
  - name
```
String name
```
    Required. The name of this variable.
    
    Returns:
    
    String name
- - defaultValue
```
String defaultValue
```
    Required. The default value of this variable.
    
    Returns:
    
    String defaultValue
- - allowableValues
```
String[] allowableValues
```
    An array of allowable values for this variable. This field map to the enum property in the OAS schema.
    
    Returns:
    
    String array of allowableValues
    
    Default:
    
    {""}
- - description
```
String description
```
    An optional description for the server variable.
    
    Returns:
    
    String description
    
    Default:
    
    ""
- - extensions
```
Extension[] extensions
```
    The list of optional extensions
    
    Returns:
    
    an optional array of extensions
    
    Default:
    
    {}