io.swagger.v3.oas.annotations.servers

Annotation Type ServerVariable

@Target(value={})
 @Retention(value=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 and Description
String	defaultValue Required.
String	name Required.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and 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

public abstract String name

Required. The name of this variable.

Returns:

String name

defaultValue

public abstract String defaultValue

Required. The default value of this variable.

Returns:

String defaultValue

allowableValues

public abstract 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

public abstract String description

An optional description for the server variable.

Returns:

String description

Default:

""

extensions

public abstract Extension[] extensions

The list of optional extensions

Returns:

an optional array of extensions

Default:

{}