View Source OpenApiSpex.Example (open_api_spex v3.21.1)

Defines the OpenApiSpex.Example.t type.

Summary

Types

t()

Types

t()

@type t() :: %OpenApiSpex.Example{
  description: String.t() | nil,
  extensions: %{required(String.t()) => any()} | 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.