tapir-core
API
Generated with
tapir-core/sttp.tapir/EndpointIO/annotations

annotations

sttp.tapir.EndpointIO.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.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

sealed trait EndpointInputAnnotation extends StaticAnnotation

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Known subtypes
class body[R, CF]
class fileBody
class formBody
class jsonbody
class xmlbody
class cookie
class cookies
class description
class example
class header
class headers
class params
class path
class query
Show all
sealed trait EndpointOutputAnnotation extends StaticAnnotation

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Known subtypes
class body[R, CF]
class fileBody
class formBody
class jsonbody
class xmlbody
class cookies
class description
class example
class header
class headers
class setCookie
class setCookies
class statusCode
Show all
class apikey(val challenge: WWWAuthenticateChallenge) extends StaticAnnotation

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
class basic(val challenge: WWWAuthenticateChallenge) extends StaticAnnotation

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
class bearer(val challenge: WWWAuthenticateChallenge) extends StaticAnnotation

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
class body[R, CF <: CodecFormat](val bodyType: RawBodyType[R], val cf: CF) extends EndpointInputAnnotation, EndpointOutputAnnotation

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
Known subtypes
class fileBody
class formBody
class jsonbody
class xmlbody
Show all
class byteArrayBody extends body[Array[Byte], OctetStream]

Attributes

Supertypes
class body[Array[Byte], OctetStream]
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class byteBufferBody extends body[ByteBuffer, OctetStream]

Attributes

Supertypes
class body[ByteBuffer, OctetStream]
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class cookie(val name: String) extends EndpointInputAnnotation

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class cookies extends EndpointInputAnnotation, EndpointOutputAnnotation

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class customise(val f: EndpointTransput[_] => EndpointTransput[_]) extends StaticAnnotation

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
class description(val text: String) extends EndpointInputAnnotation, 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.

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
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.

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class example(val example: Any) extends EndpointInputAnnotation, 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.

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class fileBody extends body[FileRange, OctetStream]

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class formBody extends body[String, XWwwFormUrlencoded]

Attributes

Supertypes
class body[String, XWwwFormUrlencoded]
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class header(val name: String) extends EndpointInputAnnotation, EndpointOutputAnnotation

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class headers extends EndpointInputAnnotation, EndpointOutputAnnotation

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class inputStreamBody extends body[InputStream, OctetStream]

Attributes

Supertypes
class body[InputStream, OctetStream]
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class jsonbody extends body[String, Json]

Attributes

Supertypes
class body[String, Json]
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class multipartBody extends body[Seq[RawPart], MultipartFormData]

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class params extends EndpointInputAnnotation

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class path extends EndpointInputAnnotation

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class query(val name: String) extends EndpointInputAnnotation

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class securitySchemeName(val name: String) extends StaticAnnotation

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
class setCookie(val name: String) extends EndpointOutputAnnotation

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class setCookies extends EndpointOutputAnnotation

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class statusCode extends EndpointOutputAnnotation

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
class xmlbody extends body[String, Xml]

Attributes

Supertypes
class body[String, Xml]
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
Show all
Generated with