Discriminator

zio.http.endpoint.openapi.OpenAPI.Discriminator
See theDiscriminator companion object
final case class Discriminator(propertyName: String, mapping: Map[String, String])

When request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.

When using the discriminator, inline schemas will not be considered.

Value parameters

mapping

An object to hold mappings between payload values and schema names or references.

propertyName

The name of the property in the payload that will hold the discriminator value.

Attributes

Companion
object
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]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product