ServerVariable

zio.http.endpoint.openapi.OpenAPI.ServerVariable

See theServerVariable companion object

final case class ServerVariable(enum: Chunk[String], default: String, description: Doc)

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

Value parameters

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.

Companion: object
Graph
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

In this article

Generated with