open_api_spex

v3.4.0

open_api_spex v3.4.0 OpenApiSpex.Discriminator View Source

Defines the OpenApiSpex.Discriminator.t type.

Link to this section Summary

Types

t()

Discriminator Object

Functions

resolve(map, value, schemas)

Resolve the schema that should be used to cast/validate a value using a Discriminator

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.

Link to this section Functions

Link to this function

resolve(map, value, schemas) View Source 
resolve(t(), map(), %{optional(String.t()) => OpenApiSpex.Schema.t()}) ::
  {:ok, OpenApiSpex.Schema.t()} | {:error, String.t()}

Resolve the schema that should be used to cast/validate a value using a Discriminator.