open_api_spex

v3.4.0

open_api_spex v3.4.0 OpenApiSpex.Example View Source

Defines the OpenApiSpex.Example.t type.

Link to this section Summary

Types

t()

Example Object

Link to this section Types

Link to this type

t() View Source 
t() :: %OpenApiSpex.Example{
  description: String.t() | nil,
  externalValue: String.t() | nil,
  summary: String.t() | nil,
  value: any()
}

Example Object

In all cases, the example value is expected to be compatible with the type schema of its associated value.