View Source OpenApiSpex.Cast.Discriminator (open_api_spex v3.16.0)

Defines the OpenApiSpex.Discriminator.t type.

Link to this section Summary

Link to this section Types

@type t() :: %OpenApiSpex.Cast.Discriminator{
  mapping: %{required(String.t()) => String.t()} | nil,
  propertyName: String.t()
}

Discriminator Object

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.

A discriminator requires a composite key be set on the schema:

  • allOf
  • oneOf
  • anyOf

Link to this section Functions