Discriminator

zio.http.api.openapi.OpenAPI$.Discriminator
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.

Attributes

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.

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