tapir-core/sttp.tapir/EndpointIO/annotations/example

example

sttp.tapir.EndpointIO$.annotations$.example

class example(val example: Any) extends EndpointInputAnnotation with EndpointOutputAnnotation

Specifies the example value of the endpoint input/output. Note that this is distinct from Schema.annotations.encodedExample, which sets the example on the schema associated with the input/output.

Attributes

Graph
Supertypes: trait EndpointOutputAnnotation
trait EndpointInputAnnotation
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any

example

Attributes

Members list

Value members

Concrete fields