open_api_spex v2.1.1 OpenApiSpex.Discriminator View Source

Defines the OpenApiSpex.Discriminator.t type.

Link to this section Summary

Link to this section Types

Link to this type t() View Source
t() :: %OpenApiSpex.Discriminator{
  mapping: %{optional(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.