tapir-core/sttp.tapir/EndpointInput

EndpointInput

object EndpointInput extends EndpointInputMacros
Companion:
class
trait Sum
trait Mirror
class Object
trait Matchable
class Any

Type members

Classlikes

sealed trait Atom[T] extends Basic[T] with Atom[T]
case class Auth[T, TYPE <: AuthType](input: Single[T], challenge: WWWAuthenticateChallenge, authType: TYPE, info: AuthInfo) extends Single[T]

An input with authentication credentials metadata, used when generating documentation.

An input with authentication credentials metadata, used when generating documentation.

case class AuthInfo(securitySchemeName: Option[String], description: Option[String], attributes: AttributeMap, group: Option[String], bearerFormat: Option[String])
Companion:
object
object AuthInfo
Companion:
class
object AuthType
Companion:
class
sealed trait AuthType
Companion:
object
sealed trait Basic[T] extends Single[T] with Basic[T]
case class Cookie[T](name: String, codec: Codec[Option[String], T, TextPlain], info: Info[T]) extends Atom[T]
case class ExtractFromRequest[T](codec: Codec[ServerRequest, T, TextPlain], info: Info[T]) extends Atom[T]
case class FixedMethod[T](m: Method, codec: Codec[Unit, T, TextPlain], info: Info[T]) extends Atom[T]
case class FixedPath[T](s: String, codec: Codec[Unit, T, TextPlain], info: Info[T]) extends Atom[T]
case class MappedPair[T, U, TU, V](input: Pair[T, U, TU], mapping: Mapping[TU, V]) extends Single[V]
case class Pair[T, U, TU](left: EndpointInput[T], right: EndpointInput[U], combine: CombineParams, split: SplitParams) extends EndpointInput[TU] with Pair[TU]
case class PathCapture[T](name: Option[String], codec: Codec[String, T, TextPlain], info: Info[T]) extends Atom[T]
case class PathsCapture[T](codec: Codec[List[String], T, TextPlain], info: Info[T]) extends Atom[T]
case class Query[T](name: String, flagValue: Option[T], codec: Codec[List[String], T, TextPlain], info: Info[T]) extends Atom[T]
case class QueryParams[T](codec: Codec[QueryParams, T, TextPlain], info: Info[T]) extends Atom[T]
sealed trait Single[T] extends EndpointInput[T]

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Inherited from:
Mirror

Value members

Inherited methods

inline def derived[T <: Product]: EndpointInput[T]

Derives an input 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.

Derives an input 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.

Inherited from:
EndpointInputMacros