EndpointOutput

Specifies one possible output.

When encoding to a response, this output is used if:

1. appliesTo applied to the output value (as returned by the server logic) returns true.
2. when a fixed content type specified by the output matches the request's Accept header

When decoding from a response, this output is used if it decodes successfully.

The appliesTo function should determine, whether a runtime value matches the type O. This check cannot be in general done by checking the run-time class of the value, due to type erasure (if O has type parameters).

The names of the product elements

The name of the type

Derives an output description using metadata specified with annotations on the given case class. Each field of the case class must be annotated with one of the annotations from sttp.tapir.EndpointIO.annotations. Additional schema meta-data can be specified using annotations from sttp.tapir.Schema.annotations. The result is mapped to an instance of the T type.