ServerVariable

zio.http.api.openapi.OpenAPI$.ServerVariable
final case class ServerVariable(enum: NonEmptyChunk[String], default: String, description: Doc)

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

Attributes

default

The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object’s treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value SHOULD exist in the enum’s values.

description

A description for the server variable.

enum

An enumeration of string values to be used if the substitution options are from a limited set.

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

override def toJson: String

Attributes

Definition Classes
OpenAPIBase

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product