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

EndpointIO

sttp.tapir.EndpointIO
See theEndpointIO companion trait
object EndpointIO

Attributes

Companion
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
EndpointIO.type

Members list

Type members

Classlikes

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

Attributes

Supertypes
trait Atom[I]
trait Atom[I]
trait Atom[I]
trait Basic[I]
trait Basic[I]
trait Basic[I]
trait Basic[I]
trait Single[I]
trait Single[I]
trait Single[I]
trait EndpointIO[I]
trait EndpointOutput[I]
trait EndpointInput[I]
trait EndpointTransput[I]
class Object
trait Matchable
class Any
Show all
Known subtypes
class Body[R, T]
class Empty[T]
class FixedHeader[T]
class Header[T]
class Headers[T]
class StreamBodyWrapper[BS, T]
Show all
sealed trait Basic[I] extends Single[I], Basic[I], Basic[I]

Attributes

Supertypes
trait Basic[I]
trait Basic[I]
trait Basic[I]
trait Single[I]
trait Single[I]
trait Single[I]
trait EndpointIO[I]
trait EndpointOutput[I]
trait EndpointInput[I]
trait EndpointTransput[I]
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 OneOfBody[O, T]
Show all
case class Body[R, T](bodyType: RawBodyType[R], codec: Codec[R, T, CodecFormat], info: Info[T]) extends Atom[T]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Atom[T]
trait Atom[T]
trait Atom[T]
trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait Single[T]
trait Single[T]
trait EndpointIO[T]
trait EndpointOutput[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
case class Empty[T](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 Atom[T]
trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait Single[T]
trait Single[T]
trait EndpointIO[T]
trait EndpointOutput[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
case class Example[+T](value: T, name: Option[String], summary: Option[String], description: Option[String])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Example.type
case class FixedHeader[T](h: Header, 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 Atom[T]
trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait Single[T]
trait Single[T]
trait EndpointIO[T]
trait EndpointOutput[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
case class Header[T](name: String, 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 Atom[T]
trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait Single[T]
trait Single[T]
trait EndpointIO[T]
trait EndpointOutput[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
case class Headers[T](codec: Codec[List[Header], T, TextPlain], info: Info[T]) extends Atom[T]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Atom[T]
trait Atom[T]
trait Atom[T]
trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait Single[T]
trait Single[T]
trait EndpointIO[T]
trait EndpointOutput[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
case class Info[T](description: Option[String], examples: List[Example[T]], deprecated: Boolean, attributes: AttributeMap)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Info.type
case class MappedPair[T, U, TU, V](io: Pair[T, U, TU], mapping: Mapping[TU, V]) extends Single[V]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Single[V]
trait Single[V]
trait Single[V]
trait EndpointIO[V]
trait EndpointOutput[V]
trait EndpointInput[V]
trait EndpointTransput[V]
class Object
trait Matchable
class Any
Show all
case class OneOfBody[O, T](variants: List[OneOfBodyVariant[O]], mapping: Mapping[O, T]) extends Basic[T]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Basic[T]
trait Basic[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait Single[T]
trait Single[T]
trait EndpointIO[T]
trait EndpointOutput[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
case class OneOfBodyVariant[O](range: ContentTypeRange, body: Either[Body[_, O], StreamBodyWrapper[_, O]])

Attributes

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

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Pair[TU]
trait EndpointIO[TU]
trait EndpointOutput[TU]
trait EndpointInput[TU]
trait EndpointTransput[TU]
class Object
trait Matchable
class Any
Show all
sealed trait Single[I] extends EndpointIO[I], Single[I], Single[I]

Attributes

Supertypes
trait Single[I]
trait Single[I]
trait EndpointIO[I]
trait EndpointOutput[I]
trait EndpointInput[I]
trait EndpointTransput[I]
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]
class MappedPair[T, U, TU, V]
Show all
case class StreamBodyWrapper[BS, T](wrapped: StreamBodyIO[BS, T, _]) extends Atom[T]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Atom[T]
trait Atom[T]
trait Atom[T]
trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait Single[T]
trait Single[T]
trait EndpointIO[T]
trait EndpointOutput[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
object annotations

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

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type

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
Generated with