tapir-core
API
Generated with
tapir-core/sttp.tapir/EndpointInput

EndpointInput

sttp.tapir.EndpointInput
See theEndpointInput companion trait
object EndpointInput extends EndpointInputMacros

Attributes

Companion
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Classlikes

sealed trait Atom[T] extends Basic[T], Atom[T]

Attributes

Supertypes
trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
Known subtypes
trait Atom[I]
class Body[R, T]
class Empty[T]
class FixedHeader[T]
class Header[T]
class Headers[T]
class StreamBodyWrapper[BS, T]
class Cookie[T]
class FixedMethod[T]
class FixedPath[T]
class PathCapture[T]
class PathsCapture[T]
class Query[T]
class QueryParams[T]
Show all
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.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Single[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
case class AuthInfo(securitySchemeName: Option[String], description: Option[String], attributes: AttributeMap, group: Option[String], bearerFormat: Option[String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AuthInfo

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
AuthInfo.type
object AuthType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
AuthType.type
sealed trait AuthType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ApiKey
class Http
class OAuth2
class ScopedOAuth2
sealed trait Basic[T] extends Single[T], Basic[T]

Attributes

Supertypes
trait Basic[T]
trait Single[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
Known subtypes
trait Basic[I]
trait Atom[I]
class Body[R, T]
class Empty[T]
class FixedHeader[T]
class Header[T]
class Headers[T]
class StreamBodyWrapper[BS, T]
class OneOfBody[O, T]
trait Atom[T]
class Cookie[T]
class FixedMethod[T]
class FixedPath[T]
class PathCapture[T]
class PathsCapture[T]
class Query[T]
class QueryParams[T]
Show all
case class Cookie[T](name: String, codec: Codec[Option[String], T, TextPlain], info: Info[T]) extends Atom[T]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Atom[T]
trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
case class ExtractFromRequest[T](codec: Codec[ServerRequest, T, TextPlain], info: Info[T]) extends Atom[T]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Atom[T]
trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
case class FixedMethod[T](m: Method, codec: Codec[Unit, T, TextPlain], info: Info[T]) extends Atom[T]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Atom[T]
trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
case class FixedPath[T](s: String, codec: Codec[Unit, T, TextPlain], info: Info[T]) extends Atom[T]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Atom[T]
trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
case class MappedPair[T, U, TU, V](input: Pair[T, U, TU], mapping: Mapping[TU, V]) extends Single[V]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Single[V]
trait EndpointInput[V]
trait EndpointTransput[V]
class Object
trait Matchable
class Any
Show all
case class Pair[T, U, TU](left: EndpointInput[T], right: EndpointInput[U], combine: CombineParams, split: SplitParams) extends EndpointInput[TU], Pair[TU]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Pair[TU]
trait EndpointInput[TU]
trait EndpointTransput[TU]
class Object
trait Matchable
class Any
Show all
case class PathCapture[T](name: Option[String], codec: Codec[String, T, TextPlain], info: Info[T]) extends Atom[T]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Atom[T]
trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
case class PathsCapture[T](codec: Codec[List[String], T, TextPlain], info: Info[T]) extends Atom[T]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Atom[T]
trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
case class Query[T](name: String, flagValue: Option[T], codec: Codec[List[String], T, CodecFormat], info: Info[T]) extends Atom[T]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Atom[T]
trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
case class QueryParams[T](codec: Codec[QueryParams, T, TextPlain], info: Info[T]) extends Atom[T]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Atom[T]
trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
sealed trait Single[T] extends EndpointInput[T]

Attributes

Supertypes
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
Known subtypes
trait Single[I]
trait Basic[I]
trait Atom[I]
class Body[R, T]
class Empty[T]
class FixedHeader[T]
class Header[T]
class Headers[T]
class StreamBodyWrapper[BS, T]
class OneOfBody[O, T]
class MappedPair[T, U, TU, V]
class Auth[T, TYPE]
trait Basic[T]
trait Atom[T]
class Cookie[T]
class FixedMethod[T]
class FixedPath[T]
class PathCapture[T]
class PathsCapture[T]
class Query[T]
class QueryParams[T]
class MappedPair[T, U, TU, V]
Show all

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

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.

Attributes

Inherited from:
EndpointInputMacros
Generated with