ServerVariable

zio.blocks.openapi.ServerVariable
See theServerVariable companion object
final case class ServerVariable(default: String, enum: Chunk[String] = ..., description: Option[Doc] = ..., extensions: ChunkMap[String, Json] = ...)

Creates a ServerVariable with validation. If enum is non-empty, the default value MUST be one of the enum values.

Value parameters

default

REQUIRED. The default value to use for substitution.

description

An optional description for the server variable.

enum

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

extensions

Specification extensions (x-* fields).

Attributes

Companion
object
Source
OpenAPI.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Attributes

Inherited from:
Product
Source
Product.scala
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns

in the default implementation, an Iterator[Any]

Inherited from:
Product
Source
Product.scala