ServerVariable

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Field |
Required |
Optional

Detail:
Field |
Element

```
@Target(value={})
 @Retention(value=RUNTIME)
 @Inherited
public @interface ServerVariable
```
An object representing a Server Variable for server URL template substitution.

See Also:

ServerVariable Object

Required Element Summary

Required Elements
Modifier and Type	Required Element and Description
`java.lang.String`	`defaultValue` The default value of this server variable.
`java.lang.String`	`name` The name of this server variable.

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`java.lang.String`	`description` An optional description for the server variable.
`java.lang.String[]`	`enumeration` An array of enum values for this variable.

- Element Detail
  - name
```
public abstract java.lang.String name
```
    The name of this server variable. This is a REQUIRED property.
    
    Returns:
    
    the name of the server variable
- - defaultValue
```
public abstract java.lang.String defaultValue
```
    The default value of this server variable. This is a REQUIRED property.
    
    Returns:
    
    the defualt value of this server variable
- - enumeration
```
public abstract java.lang.String[] enumeration
```
    An array of enum values for this variable. This field maps to the enum property in the OAS schema and to enumeration field of ServerVariable model.
    
    Returns:
    
    array of possible values for this ServerVariable
    
    Default:
    
    {}
- - description
```
public abstract java.lang.String description
```
    An optional description for the server variable. CommonMark syntax can be used for rich text representation.
    
    Returns:
    
    the description of this server variable
    
    Default:
    
    ""

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Field |
Required |
Optional

Detail:
Field |
Element