open_api_spex v2.0.0 OpenApiSpex.Example View Source

Defines the OpenApiSpex.Example.t type.

Link to this section Summary

Link to this section Types

Link to this type t() View Source
t() :: %OpenApiSpex.Example{
  description: String.t(),
  externalValue: String.t(),
  summary: String.t(),
  value: any()
}

Example Object

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