Type Members

1.  type AnyEndpoint = Endpoint[_, _, _, _, _]
2.  type AnyListCodec = Codec[_ <: List[_], _, _ <: CodecFormat]
3.  type AnyPart = Part[_]
4.  class AttributeKey[T] extends AnyRef
   T

   Type of the value of the attribute.

5.  case class AttributeMap extends Product with Serializable

   An attribute is arbitrary data that is attached to an endpoint or endpoint input/output.

   An attribute is arbitrary data that is attached to an endpoint or endpoint input/output. The data is not interpreted by tapir's core in any way, but might be used by interpreters.

   Typically, you'll add attributes using Endpoint.attribute and EndpointTransput.Basic.attribute. The attribute keys should be defined by the interpreters which are using them, and made available for import.

6.  trait Codec[L, H, +CF <: CodecFormat] extends AnyRef

   A bi-directional mapping between low-level values of type L and high-level values of type H.

   A bi-directional mapping between low-level values of type L and high-level values of type H. Low level values are formatted as CF.

   The mapping consists of a pair of functions, one to decode (L => H), and one to encode (H => L) Decoding can fail, and this is represented as a result of type DecodeResult.

   A codec also contains optional meta-data on the schema of the high-level value, as well as an instance of the format (which determines the media type of the low-level value).

   Codec instances are used as implicit values, and are looked up when defining endpoint inputs/outputs. Depending on a particular endpoint input/output, it might require a codec which uses a specific format, or a specific low-level value.

   Codec instances can be derived basing on other values (e.g. such as json encoders/decoders when integrating with json libraries). Or, they can be defined by hand for custom types, usually customising an existing, simpler codec.

   Codecs can be chained with Mapping s using the map function.

   L

   The type of the low-level value.

   H

   The type of the high-level value.

   CF

   The format of encoded values. Corresponds to the media type.

   Annotations

   @implicitNotFound( ... )

7.  trait CodecExtensions extends AnyRef
8.  trait CodecFormat extends AnyRef

   Specifies the format of the encoded values.

   Specifies the format of the encoded values. Each variant must be a proper type so that it can be used as a discriminator for different (implicit) instances of Codec values.

9.  sealed trait DecodeResult[+T] extends AnyRef
10.  case class Endpoint[A, I, E, O, -R](securityInput: EndpointInput[A], input: EndpointInput[I], errorOutput: EndpointOutput[E], output: EndpointOutput[O], info: EndpointInfo) extends EndpointSecurityInputsOps[A, I, E, O, R] with EndpointInputsOps[A, I, E, O, R] with EndpointErrorOutputsOps[A, I, E, O, R] with EndpointErrorOutputVariantsOps[A, I, E, O, R] with EndpointOutputsOps[A, I, E, O, R] with EndpointInfoOps[R] with EndpointMetaOps with EndpointServerLogicOps[A, I, E, O, R] with Product with Serializable

    A description of an endpoint with the given inputs & outputs.

    A description of an endpoint with the given inputs & outputs. The inputs are divided into two parts: security (A) and regular inputs (I). There are also two kinds of outputs: error outputs (E) and regular outputs (O).

    In case there are no security inputs, the PublicEndpoint alias can be used, which omits the A parameter type.

    An endpoint can be interpreted as a server, client or documentation. The endpoint requires that server/client interpreters meet the capabilities specified by R (if any).

    When interpreting an endpoint as a server, the inputs are decoded and the security logic is run first, before decoding the body in the regular inputs. This allows short-circuiting further processing in case security checks fail. Server logic can be provided using EndpointServerLogicOps.serverSecurityLogic variants for secure endpoints, and EndpointServerLogicOps.serverLogic variants for public endpoints.

    A concise description of an endpoint can be generated using the EndpointMetaOps.show method.

    A

    Security input parameter types.

    I

    Input parameter types.

    E

    Error output parameter types.

    O

    Output parameter types.

    R

    The capabilities that are required by this endpoint's inputs/outputs. This might be Any (no requirements), sttp.capabilities.Effect (the interpreter must support the given effect type), sttp.capabilities.Streams (the ability to send and receive streaming bodies) or sttp.capabilities.WebSockets (the ability to handle websocket requests).

11.  trait EndpointErrorOutputVariantsOps[A, I, E, O, -R] extends AnyRef
12.  trait EndpointErrorOutputsOps[A, I, E, O, -R] extends EndpointErrorOutputsMacros[A, I, E, O, R]
13.  sealed trait EndpointIO[T] extends EndpointInput[T] with EndpointOutput[T]
14.  case class EndpointInfo(name: Option[String], summary: Option[String], description: Option[String], tags: Vector[String], deprecated: Boolean, attributes: AttributeMap) extends Product with Serializable
15.  trait EndpointInfoOps[-R] extends AnyRef
16.  sealed trait EndpointInput[T] extends EndpointTransput[T]
17.  trait EndpointInputsOps[A, I, E, O, -R] extends EndpointInputsMacros[A, I, E, O, R]
18.  trait EndpointMetaOps extends AnyRef
19.  sealed trait EndpointOutput[T] extends EndpointTransput[T]
20.  trait EndpointOutputsOps[A, I, E, O, -R] extends EndpointOutputsMacros[A, I, E, O, R]
21.  trait EndpointSecurityInputsOps[A, I, E, O, -R] extends EndpointSecurityInputsMacros[A, I, E, O, R]
22.  trait EndpointServerLogicOps[A, I, E, O, -R] extends AnyRef
23.  sealed trait EndpointTransput[T] extends EndpointTransputMacros[T]

    A transput is EITHER an input, or an output (see: https://ell.stackexchange.com/questions/21405/hypernym-for-input-and-output).

    A transput is EITHER an input, or an output (see: https://ell.stackexchange.com/questions/21405/hypernym-for-input-and-output). The transput traits contain common functionality, shared by all inputs and outputs.

    Note that implementations of EndpointIO can be used BOTH as inputs and outputs.

    The hierarchy is as follows:

                            /---> `EndpointInput`  >---\
    `EndpointTransput` >---                            ---> `EndpointIO`
                            \---> `EndpointOutput` >---/

24.  case class FieldName(name: String, encodedName: String) extends Product with Serializable
25.  case class FileRange(file: tapir.TapirFile, range: Option[RangeValue] = None) extends Product with Serializable
26.  trait LowPriorityCodec extends AnyRef

    Lower-priority codec implicits, which transform other codecs.

    Lower-priority codec implicits, which transform other codecs. For example, when deriving a codec List[T] <-> Either[A, B], given codecs ca: T <-> A and cb: T <-> B, we want to get listHead(eitherRight(ca, cb)), not eitherRight(listHead(ca), listHead(cb)) (although they would function the same).

27.  trait LowPrioritySchema extends AnyRef
28.  trait Mapping[L, H] extends AnyRef

    A bi-directional mapping between values of type L and values of type H.

    A bi-directional mapping between values of type L and values of type H.

    Low-level values of type L can be **decoded** to a higher-level value of type H. The decoding can fail; this is represented by a result of type DecodeResult.Failure. Failures might occur due to format errors, wrong arity, exceptions, or validation errors. Validators can be added through the validate method.

    High-level values of type H can be **encoded** as a low-level value of type L.

    Mappings can be chained using one of the map functions.

    L

    The type of the low-level value.

    H

    The type of the high-level value.

29.  case class MultipartCodec[T](rawBodyType: MultipartBody, codec: Codec[Seq[RawPart], T, MultipartFormData]) extends Product with Serializable
30.  case class PartCodec[R, T](rawBodyType: RawBodyType[R], codec: Codec[List[Part[R]], T, _ <: CodecFormat]) extends Product with Serializable

    Information needed to read a single part of a multipart body: the raw type (rawBodyType), and the codec which further decodes it.

31.  type PublicEndpoint[I, E, O, -R] = Endpoint[Unit, I, E, O, R]
32.  case class RangeValue(start: Option[Long], end: Option[Long], fileSize: Long) extends Product with Serializable
33.  sealed trait RawBodyType[R] extends AnyRef

    The raw format of the body: what do we need to know, to read it and pass to a codec for further decoding.

34.  type RawPart = Part[_]
35.  case class Schema[T](schemaType: SchemaType[T], name: Option[SName] = None, isOptional: Boolean = false, description: Option[String] = None, default: Option[(T, Option[Any])] = None, format: Option[String] = None, encodedExample: Option[Any] = None, deprecated: Boolean = false, validator: Validator[T] = Validator.pass[T]) extends SchemaMacros[T] with Product with Serializable

    Describes the type T: its low-level representation, meta-data and validation rules.

    Describes the type T: its low-level representation, meta-data and validation rules.

    format

    The name of the format of the low-level representation of T.

    Annotations

    @implicitNotFound( ... )

36.  sealed trait SchemaType[T] extends AnyRef

    The type of the low-level representation of a T values.

    The type of the low-level representation of a T values. Part of Schemas.

37.  case class StreamBodyIO[BS, T, S](streams: Streams[S], codec: Codec[BS, T, CodecFormat], info: Info[T], charset: Option[Charset], encodedExamples: List[Example[Any]]) extends Basic[T] with Product with Serializable
38.  trait Tapir extends TapirExtensions with TapirComputedInputs with TapirStaticContentEndpoints with ModifyMacroSupport
39.  final class WebSocketBodyBuilder[REQ, REQ_CF <: CodecFormat, RESP, RESP_CF <: CodecFormat] extends AnyRef

    Definition Classes

    Tapir

40.  trait TapirAliases extends AnyRef

    Mixin containing aliases for top-level types and modules in the tapir package.

41.  trait TapirComputedInputs extends AnyRef
42.  trait TapirExtensions extends AnyRef
43.  type TapirFile = File

    Definition Classes

    TapirExtensions

44.  class UnsupportedWebSocketFrameException extends WebSocketException
45.  sealed trait ValidationError[T] extends AnyRef
46.  sealed trait Validator[T] extends AnyRef
47.  case class WebSocketBodyOutput[PIPE_REQ_RESP, REQ, RESP, T, S](streams: Streams[S], requests: Codec[WebSocketFrame, REQ, CodecFormat], responses: Codec[WebSocketFrame, RESP, CodecFormat], codec: Codec[PIPE_REQ_RESP, T, CodecFormat], info: Info[T], requestsInfo: Info[REQ], responsesInfo: Info[RESP], concatenateFragmentedFrames: Boolean, ignorePong: Boolean, autoPongOnPing: Boolean, decodeCloseRequests: Boolean, decodeCloseResponses: Boolean, autoPing: Option[(FiniteDuration, Ping)]) extends Basic[T] with Product with Serializable
48.  class WebSocketFrameDecodeFailure extends WebSocketException
49.  implicit class ModifyEach[F[_], T] extends AnyRef

    Definition Classes

    ModifyMacroFunctorSupport

50.  trait ModifyFunctor[F[_], A] extends AnyRef

    Definition Classes

    ModifyMacroFunctorSupport

51.  implicit class ModifyEachMap[F[_, _], K, T] extends AnyRef

    Definition Classes

    ModifyMacroSupport

52.  trait ModifyMapAtFunctor[F[_, _], K, T] extends AnyRef

    Definition Classes

    ModifyMacroSupport