Example
final case class Example(summary: String, description: Doc, externalValue: URI) extends ExampleOrReference
In all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.
- Value parameters:
- description
Long description for the example.
- externalValue
A URL that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents.
- summary
Short description for the example.
trait Serializable
trait Product
trait Equals
trait ExampleOrReference
class Object
trait Matchable
class Any