MicroProfile 7.0 · org.eclipse.microprofile.openapi.annotations.servers.ServerVariable

Method Summary

Modifier and Type	Method and Description
public String	Returns: the default value of this server variable defaultValue() The default value of this server variable.
public String	Returns: the description of this server variable description() An optional description for the server variable.
public String[]	Returns: array of possible values for this ServerVariable enumeration() An array of enum values for this variable.
public Extension[]	Returns: array of extensions extensions() List of extensions to be added to the `ServerVariable` model corresponding to the containing annotation.
public String	Returns: the name of the server variable name() The name of this server variable.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

defaultValue back to summary

defaultValue	back to summary
public String defaultValue() The default value of this server variable. This is a REQUIRED property. If `enumeration` is set the default value MUST be one of the values in `enumeration`. Returns:String the default value of this server variable

public String defaultValue()

The default value of this server variable. This is a REQUIRED property.

If enumeration is set the default value MUST be one of the values in enumeration.

description	back to summary
public String description() An optional description for the server variable. CommonMark syntax can be used for rich text representation. Returns:String the description of this server variable

description

public String description()

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

enumeration	back to summary
public 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:String[] array of possible values for this ServerVariable

enumeration

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

extensions back to summary

extensions	back to summary
public Extension[] extensions() List of extensions to be added to the `ServerVariable` model corresponding to the containing annotation. Returns:Extension[] array of extensions Since 3.1

public Extension[] extensions()

List of extensions to be added to the ServerVariable model corresponding to the containing annotation.

name	back to summary
public String name() The name of this server variable. This is a REQUIRED property. Returns:String the name of the server variable

name

public String name()

The name of this server variable. This is a REQUIRED property.