Annotation Interface OpenApi.ServerVariable

Enclosing class:
OpenApi
@Target({}) @Retention(CLASS) @Documented public static @interface OpenApi.ServerVariable
OpenAPI Server Variable Object metadata.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    defaultValue
    Default value.
    String
    name
    Variable name.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    Variable description.
    String[]
    enumeration
    Allowed values.

  • Element Details

    • name

      String name
      Variable name.
      Returns:
      variable name

    • defaultValue

      String defaultValue
      Default value.

      The default value can be empty. When enumeration() is set, it must contain the default value.

      Returns:
      default value

    • enumeration

      String[] enumeration
      Allowed values.
      Returns:
      allowed values
      Default:
      {}

    • description

      String description
      Variable description.
      Returns:
      description
      Default:
      ""