zio-http-shaded/zio.http/zio.http.endpoint/zio.http.endpoint.openapi/OpenAPI/Example

Example

zio.http.endpoint.openapi.OpenAPI.Example

See theExample companion object

final case class Example(value: Json, summary: Option[String], description: Option[Doc], externalValue: Option[URI])

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.

Attributes

Companion: object
Graph
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Members list

Value members

Inherited methods

Attributes

Inherited from:: Product

Attributes

Inherited from:: Product

In this article

Generated with