tapir-core/sttp.tapir/EndpointIO/annotations

annotations

object annotations

Annotations which are used by EndpointInput.derived and EndpointOutput.derived to specify how a case class maps to an endpoint input/output.

class Object
trait Matchable
class Any

Type members

Classlikes

sealed
trait EndpointInputAnnotation extends StaticAnnotation
sealed
trait EndpointOutputAnnotation extends StaticAnnotation
class apikey(val challenge: WWWAuthenticateChallenge) extends StaticAnnotation
class basic(val challenge: WWWAuthenticateChallenge) extends StaticAnnotation
class bearer(val challenge: WWWAuthenticateChallenge) extends StaticAnnotation
class body[R, CF <: CodecFormat](val bodyType: RawBodyType[R], val cf: CF) extends EndpointInputAnnotation with EndpointOutputAnnotation
class cookie(val name: String) extends EndpointInputAnnotation
class cookies extends EndpointInputAnnotation with EndpointOutputAnnotation
class description(val text: String) extends EndpointInputAnnotation with EndpointOutputAnnotation

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

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

class endpointInput(val path: String) extends EndpointInputAnnotation

A class-level annotation, specifies the path to the endpoint. To capture segments of the path, surround the segment's name with {...} (curly braces), and reference the name using annotations.path.

A class-level annotation, specifies the path to the endpoint. To capture segments of the path, surround the segment's name with {...} (curly braces), and reference the name using annotations.path.

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.

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.

class header(val name: String) extends EndpointInputAnnotation with EndpointOutputAnnotation
class headers extends EndpointInputAnnotation with EndpointOutputAnnotation
class jsonbody extends body[String, Json]
class params extends EndpointInputAnnotation
class path extends EndpointInputAnnotation
class query(val name: String) extends EndpointInputAnnotation
class securitySchemeName(val name: String) extends StaticAnnotation
class setCookie(val name: String) extends EndpointOutputAnnotation
class setCookies extends EndpointOutputAnnotation
class statusCode extends EndpointOutputAnnotation
class xmlbody extends body[String, Xml]