Endpoint

sttp.tapir.Endpoint
case class Endpoint[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, -R](securityInput: EndpointInput[SECURITY_INPUT], input: EndpointInput[INPUT], errorOutput: EndpointOutput[ERROR_OUTPUT], output: EndpointOutput[OUTPUT], info: EndpointInfo) extends EndpointSecurityInputsOps[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, R], EndpointInputsOps[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, R], EndpointErrorOutputsOps[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, R], EndpointErrorOutputVariantsOps[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, R], EndpointOutputsOps[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, R], EndpointInfoOps[R], EndpointMetaOps, EndpointServerLogicOps[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, R]

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.

Type parameters

ERROR_OUTPUT

Error output parameter types, abbreviated as E.

INPUT

Input parameter types, abbreviated as I.

OUTPUT

Output parameter types, abbreviated as O.

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).

SECURITY_INPUT

Security input parameter types, abbreviated as A.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait EndpointServerLogicOps[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, R]
trait EndpointInfoOps[R]
trait EndpointOutputsOps[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, R]
trait EndpointOutputsMacros[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, R]
trait EndpointErrorOutputVariantsOps[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, R]
trait EndpointErrorOutputsOps[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, R]
trait EndpointErrorOutputsMacros[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, R]
trait EndpointInputsOps[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, R]
trait EndpointInputsMacros[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, R]
trait EndpointSecurityInputsOps[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, R]
trait EndpointSecurityInputsMacros[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, R]
class Object
trait Matchable
class Any
Show all
Self type
Endpoint[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, R]

Members list

Type members

Types

override type EndpointType[_A, _I, _E, _O, -_R] = Endpoint[_A, _I, _E, _O, _R]
override type ThisType[-_R] = Endpoint[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, _R]

Value members

Inherited methods

def attribute[T](k: AttributeKey[T], v: T): ThisType[R]

Attributes

Inherited from:
EndpointInfoOps
def attribute[T](k: AttributeKey[T]): Option[T]

Attributes

Inherited from:
EndpointInfoOps
def connect: EndpointType[A, I, E, O, R]

Attributes

Inherited from:
EndpointInputsOps
def delete: EndpointType[A, I, E, O, R]

Attributes

Inherited from:
EndpointInputsOps
def deprecated(): ThisType[R]

Attributes

Inherited from:
EndpointInfoOps
def description(d: String): ThisType[R]

Attributes

Inherited from:
EndpointInfoOps
def errorOut[F, EF](o: EndpointOutput[F])(implicit ts: Aux[ERROR_OUTPUT, F, EF]): EndpointType[A, I, EF, O, R]

Attributes

Inherited from:
EndpointErrorOutputsOps
def errorOutEither[E2](o: EndpointOutput[E2]): EndpointType[A, I, Either[E, E2], O, R]

Adds a new error variant, where the current error output is represented as a Left, and the given one as a Right.

Adds a new error variant, where the current error output is represented as a Left, and the given one as a Right.

Attributes

Inherited from:
EndpointErrorOutputVariantsOps
def errorOutVariant[E2 >: ERROR_OUTPUT](o: OneOfVariant[_ <: E2])(implicit ct: ClassTag[ERROR_OUTPUT], eEqualToErasure: ErasureSameAsType[ERROR_OUTPUT]): EndpointType[A, I, E2, O, R]

Replaces the current error output with a Tapir.oneOf output, where:

Replaces the current error output with a Tapir.oneOf output, where:

  • the first output variant is the current output: oneOfVariant(errorOutput)
  • the second output variant is the given o

The variant for the current endpoint output will be created using Tapir.oneOfVariant. Hence, the current output will be used if the run-time class of the output matches E. If the erasure of the E type is different from E, there will be a compile-time failure, as no such run-time check is possible. In this case, use errorOutVariantsFromCurrent and create a variant using one of the other variant factory methods (e.g. Tapir.oneOfVariantValueMatcher).

During encoding/decoding, the new o variant will be considered after the current variant.

Usage example:

 sealed trait Parent
 case class Child1(v: String) extends Parent
 case class Child2(v: String) extends Parent

 val e: PublicEndpoint[Unit, Parent, Unit, Any] = endpoint
   .errorOut(stringBody.mapTo[Child1])
   .errorOutVariant[Parent](oneOfVariant(stringBody.mapTo[Child2]))

Adding error output variants is useful when extending the error outputs in a PartialServerEndpoint, created using EndpointServerLogicOps.serverSecurityLogic.

Type parameters

E2

A common supertype of the new variant and the current output E.

Value parameters

o

The variant to add. Can be created given an output with one of the Tapir.oneOfVariant methods.

Attributes

Inherited from:
EndpointErrorOutputVariantsOps
def errorOutVariantPrepend[E2 >: ERROR_OUTPUT](o: OneOfVariant[_ <: E2]): EndpointType[A, I, E2, O, R]

Replaces the current error output with a Tapir.oneOf output, where:

Replaces the current error output with a Tapir.oneOf output, where:

  • the first output variant is the given o
  • the second, default output variant is the current output: oneOfDefaultVariant(errorOutput)

Useful for adding specific error variants, while the more general ones are already covered by the existing error output.

During encoding/decoding, the new o variant will be considered before the current variant.

Adding error output variants is useful when extending the error outputs in a PartialServerEndpoint, created using EndpointServerLogicOps.serverSecurityLogic.

Type parameters

E2

A common supertype of the new variant and the current output E.

Value parameters

o

The variant to add. Can be created given an output with one of the Tapir.oneOfVariant methods.

Attributes

Inherited from:
EndpointErrorOutputVariantsOps
def errorOutVariants[E2 >: ERROR_OUTPUT](first: OneOfVariant[_ <: E2], other: OneOfVariant[_ <: E2]*)(implicit ct: ClassTag[ERROR_OUTPUT], eEqualToErasure: ErasureSameAsType[ERROR_OUTPUT]): EndpointType[A, I, E2, O, R]

Same as errorOutVariant, but allows appending multiple variants in one go.

Same as errorOutVariant, but allows appending multiple variants in one go.

Attributes

Inherited from:
EndpointErrorOutputVariantsOps
def errorOutVariantsFromCurrent[E2 >: ERROR_OUTPUT](variants: EndpointOutput[ERROR_OUTPUT] => List[OneOfVariant[_ <: E2]]): EndpointType[A, I, E2, O, R]

Replace the error output with a Tapir.oneOf output, using the variants returned by variants. The current output should be included in one of the returned variants.

Replace the error output with a Tapir.oneOf output, using the variants returned by variants. The current output should be included in one of the returned variants.

Allows creating the variant list in a custom order, placing the current variant in an arbitrary position, and using default variants if necessary.

Adding error output variants is useful when extending the error outputs in a PartialServerEndpoint, created using EndpointServerLogicOps.serverSecurityLogic.

Type parameters

E2

A common supertype of the new variant and the current output E.

Attributes

Inherited from:
EndpointErrorOutputVariantsOps
def errorOutVariantsPrepend[E2 >: ERROR_OUTPUT](first: OneOfVariant[_ <: E2], other: OneOfVariant[_ <: E2]*): EndpointType[A, I, E2, O, R]

Same as errorOutVariantPrepend, but allows appending multiple variants in one go.

Same as errorOutVariantPrepend, but allows appending multiple variants in one go.

Attributes

Inherited from:
EndpointErrorOutputVariantsOps
def get: EndpointType[A, I, E, O, R]

Attributes

Inherited from:
EndpointInputsOps
def head: EndpointType[A, I, E, O, R]

Attributes

Inherited from:
EndpointInputsOps
def in[BS, J, IJ, R2](i: StreamBodyIO[BS, J, R2])(implicit concat: Aux[INPUT, J, IJ]): EndpointType[A, IJ, E, O, R & R2]

Attributes

Inherited from:
EndpointInputsOps
def in[J, IJ](i: EndpointInput[J])(implicit concat: Aux[INPUT, J, IJ]): EndpointType[A, IJ, E, O, R]

Attributes

Inherited from:
EndpointInputsOps
def info(i: EndpointInfo): ThisType[R]

Attributes

Inherited from:
EndpointInfoOps
def mapErrorOut[EE](f: ERROR_OUTPUT => EE)(g: EE => ERROR_OUTPUT): EndpointType[A, I, EE, O, R]

Attributes

Inherited from:
EndpointErrorOutputVariantsOps
def mapErrorOut[EE](m: Mapping[ERROR_OUTPUT, EE]): EndpointType[A, I, EE, O, R]

Attributes

Inherited from:
EndpointErrorOutputsOps
def mapErrorOutDecode[EE](f: ERROR_OUTPUT => DecodeResult[EE])(g: EE => ERROR_OUTPUT): EndpointType[A, I, EE, O, R]

Attributes

Inherited from:
EndpointErrorOutputsOps
inline def mapErrorOutTo[CASE_CLASS <: Product](using mc: ProductOf[CASE_CLASS]): EndpointType[A, I, CASE_CLASS, O, R]

Attributes

Inherited from:
EndpointErrorOutputsMacros
def mapIn[II](f: INPUT => II)(g: II => INPUT): EndpointType[A, II, E, O, R]

Attributes

Inherited from:
EndpointInputsOps
def mapIn[II](m: Mapping[INPUT, II]): EndpointType[A, II, E, O, R]

Attributes

Inherited from:
EndpointInputsOps
def mapInDecode[II](f: INPUT => DecodeResult[II])(g: II => INPUT): EndpointType[A, II, E, O, R]

Attributes

Inherited from:
EndpointInputsOps
inline def mapInTo[CASE_CLASS <: Product](using mc: ProductOf[CASE_CLASS]): EndpointType[A, CASE_CLASS, E, O, R]

Attributes

Inherited from:
EndpointInputsMacros
def mapOut[OO](f: OUTPUT => OO)(g: OO => OUTPUT): EndpointType[A, I, E, OO, R]

Attributes

Inherited from:
EndpointOutputsOps
def mapOut[OO](m: Mapping[OUTPUT, OO]): EndpointType[A, I, E, OO, R]

Attributes

Inherited from:
EndpointOutputsOps
def mapOutDecode[OO](f: OUTPUT => DecodeResult[OO])(g: OO => OUTPUT): EndpointType[A, I, E, OO, R]

Attributes

Inherited from:
EndpointOutputsOps
inline def mapOutTo[CASE_CLASS <: Product](using mc: ProductOf[CASE_CLASS]): EndpointType[A, I, E, CASE_CLASS, R]

Attributes

Inherited from:
EndpointOutputsMacros
def mapSecurityIn[AA](f: SECURITY_INPUT => AA)(g: AA => SECURITY_INPUT): EndpointType[AA, I, E, O, R]

Attributes

Inherited from:
EndpointSecurityInputsOps
def mapSecurityIn[AA](m: Mapping[SECURITY_INPUT, AA]): EndpointType[AA, I, E, O, R]

Attributes

Inherited from:
EndpointSecurityInputsOps
def mapSecurityInDecode[AA](f: SECURITY_INPUT => DecodeResult[AA])(g: AA => SECURITY_INPUT): EndpointType[AA, I, E, O, R]

Attributes

Inherited from:
EndpointSecurityInputsOps
inline def mapSecurityInTo[CASE_CLASS <: Product](using mc: ProductOf[CASE_CLASS]): EndpointType[CASE_CLASS, I, E, O, R]

Attributes

Inherited from:
EndpointSecurityInputsMacros
def method: Option[Method]

The method defined in a fixed method input in this endpoint, if any (using e.g. EndpointInputsOps.get or EndpointInputsOps.post).

The method defined in a fixed method input in this endpoint, if any (using e.g. EndpointInputsOps.get or EndpointInputsOps.post).

Attributes

Inherited from:
EndpointMetaOps
def method(m: Method): EndpointType[A, I, E, O, R]

Attributes

Inherited from:
EndpointInputsOps
def name(n: String): ThisType[R]

Attributes

Inherited from:
EndpointInfoOps
def options: EndpointType[A, I, E, O, R]

Attributes

Inherited from:
EndpointInputsOps
def out[PIPE_REQ_RESP, P, OP, R2](i: WebSocketBodyOutput[PIPE_REQ_RESP, _, _, P, R2])(implicit ts: Aux[OUTPUT, P, OP]): EndpointType[A, I, E, OP, R & R2 & WebSockets]

Attributes

Inherited from:
EndpointOutputsOps
def out[BS, P, OP, R2](i: StreamBodyIO[BS, P, R2])(implicit ts: Aux[OUTPUT, P, OP]): EndpointType[A, I, E, OP, R & R2]

Attributes

Inherited from:
EndpointOutputsOps
def out[P, OP](i: EndpointOutput[P])(implicit ts: Aux[OUTPUT, P, OP]): EndpointType[A, I, E, OP, R]

Attributes

Inherited from:
EndpointOutputsOps
def patch: EndpointType[A, I, E, O, R]

Attributes

Inherited from:
EndpointInputsOps
def post: EndpointType[A, I, E, O, R]

Attributes

Inherited from:
EndpointInputsOps
def prependErrorOut[F, FE](o: EndpointOutput[F])(implicit ts: Aux[F, ERROR_OUTPUT, FE]): EndpointType[A, I, FE, O, R]

Attributes

Inherited from:
EndpointErrorOutputsOps
def prependIn[BS, J, JI, R2](i: StreamBodyIO[BS, J, R2])(implicit concat: Aux[J, INPUT, JI]): EndpointType[A, JI, E, O, R & R2]

Attributes

Inherited from:
EndpointInputsOps
def prependIn[J, JI](i: EndpointInput[J])(implicit concat: Aux[J, INPUT, JI]): EndpointType[A, JI, E, O, R]

Attributes

Inherited from:
EndpointInputsOps
def prependOut[PIPE_REQ_RESP, P, PO, R2](i: WebSocketBodyOutput[PIPE_REQ_RESP, _, _, P, R2])(implicit ts: Aux[P, OUTPUT, PO]): EndpointType[A, I, E, PO, R & R2 & WebSockets]

Attributes

Inherited from:
EndpointOutputsOps
def prependOut[BS, P, PO, R2](i: StreamBodyIO[BS, P, R2])(implicit ts: Aux[P, OUTPUT, PO]): EndpointType[A, I, E, PO, R & R2]

Attributes

Inherited from:
EndpointOutputsOps
def prependOut[P, PO](i: EndpointOutput[P])(implicit ts: Aux[P, OUTPUT, PO]): EndpointType[A, I, E, PO, R]

Attributes

Inherited from:
EndpointOutputsOps
def prependSecurityIn[B, BA](i: EndpointInput[B])(implicit concat: Aux[B, SECURITY_INPUT, BA]): EndpointType[BA, I, E, O, R]

Attributes

Inherited from:
EndpointSecurityInputsOps
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def put: EndpointType[A, I, E, O, R]

Attributes

Inherited from:
EndpointInputsOps
def securityIn[B, AB](i: EndpointInput[B])(implicit concat: Aux[SECURITY_INPUT, B, AB]): EndpointType[AB, I, E, O, R]

Attributes

Inherited from:
EndpointSecurityInputsOps
def serverLogic[F[_]](f: INPUT => F[Either[ERROR_OUTPUT, OUTPUT]])(implicit aIsUnit: SECURITY_INPUT =:= Unit): Full[Unit, Unit, I, E, O, R, F]

Combine this public endpoint description with a function, which implements the server-side logic. The logic returns a result, which is either an error or a successful output, wrapped in an effect type F. For secure endpoints, use serverSecurityLogic.

Combine this public endpoint description with a function, which implements the server-side logic. The logic returns a result, which is either an error or a successful output, wrapped in an effect type F. For secure endpoints, use serverSecurityLogic.

A server endpoint can be passed to a server interpreter. Each server interpreter supports effects of a specific type(s).

Both the endpoint and logic function are considered complete, and cannot be later extended through the returned ServerEndpoint value (except for endpoint meta-data). Secure endpoints allow providing the security logic before all the inputs and outputs are specified.

Attributes

Inherited from:
EndpointServerLogicOps
def serverLogicError[F[_]](f: INPUT => F[ERROR_OUTPUT])(implicit aIsUnit: SECURITY_INPUT =:= Unit): Full[Unit, Unit, I, E, O, R, F]

Like serverLogic, but specialised to the case when the result is always an error (Left), hence when the logic type can be simplified to I => F[E].

Like serverLogic, but specialised to the case when the result is always an error (Left), hence when the logic type can be simplified to I => F[E].

Attributes

Inherited from:
EndpointServerLogicOps
def serverLogicOption[F[_]](f: INPUT => F[Option[OUTPUT]])(implicit aIsUnit: SECURITY_INPUT =:= Unit, eIsUnit: ERROR_OUTPUT =:= Unit): Full[Unit, Unit, I, Unit, O, R, F]

Like serverLogic, but specialised to the case when the error type is Unit (e.g. a fixed status code), and the result of the logic function is an option. A None is then treated as an error response.

Like serverLogic, but specialised to the case when the error type is Unit (e.g. a fixed status code), and the result of the logic function is an option. A None is then treated as an error response.

Attributes

Inherited from:
EndpointServerLogicOps
def serverLogicPure[F[_]](f: INPUT => Either[ERROR_OUTPUT, OUTPUT])(implicit aIsUnit: SECURITY_INPUT =:= Unit): Full[Unit, Unit, I, E, O, R, F]

Like serverLogic, but specialised to the case when the logic function is pure, that is doesn't have any side effects.

Like serverLogic, but specialised to the case when the logic function is pure, that is doesn't have any side effects.

Attributes

Inherited from:
EndpointServerLogicOps
def serverLogicRecoverErrors[F[_]](f: INPUT => F[OUTPUT])(implicit eIsThrowable: ERROR_OUTPUT <:< Throwable, eClassTag: ClassTag[ERROR_OUTPUT], aIsUnit: SECURITY_INPUT =:= Unit): Full[Unit, Unit, I, E, O, R, F]

Same as serverLogic, but requires E to be a throwable, and converts failed effects of type E to endpoint errors.

Same as serverLogic, but requires E to be a throwable, and converts failed effects of type E to endpoint errors.

Attributes

Inherited from:
EndpointServerLogicOps
def serverLogicSuccess[F[_]](f: INPUT => F[OUTPUT])(implicit aIsUnit: SECURITY_INPUT =:= Unit): Full[Unit, Unit, I, E, O, R, F]

Like serverLogic, but specialised to the case when the result is always a success (Right), hence when the logic type can be simplified to I => F[O].

Like serverLogic, but specialised to the case when the result is always a success (Right), hence when the logic type can be simplified to I => F[O].

Attributes

Inherited from:
EndpointServerLogicOps
def serverSecurityLogic[PRINCIPAL, F[_]](f: SECURITY_INPUT => F[Either[ERROR_OUTPUT, PRINCIPAL]]): PartialServerEndpoint[A, PRINCIPAL, I, E, O, R, F]

Combine this endpoint description with a function, which implements the security logic of the endpoint.

Combine this endpoint description with a function, which implements the security logic of the endpoint.

Subsequently, the endpoint inputs and outputs can be extended (for error outputs, new variants can be added, but they cannot be arbitrarily extended). Then the main server logic can be provided, given a function which accepts as arguments the result of the security logic and the remaining input. The final result is then a ServerEndpoint.

A complete server endpoint can be passed to a server interpreter. Each server interpreter supports effects of a specific type(s).

An example use-case is defining an endpoint with fully-defined errors, and with security logic built-in. Such an endpoint can be then extended by multiple other endpoints, by specifying different inputs, outputs and the main logic.

Attributes

Inherited from:
EndpointServerLogicOps
def serverSecurityLogicError[PRINCIPAL, F[_]](f: SECURITY_INPUT => F[ERROR_OUTPUT]): PartialServerEndpoint[A, PRINCIPAL, I, E, O, R, F]

Like serverSecurityLogic, but specialised to the case when the result is always an error (Left), hence when the logic type can be simplified to A => F[E].

Like serverSecurityLogic, but specialised to the case when the result is always an error (Left), hence when the logic type can be simplified to A => F[E].

Attributes

Inherited from:
EndpointServerLogicOps
def serverSecurityLogicOption[PRINCIPAL, F[_]](f: SECURITY_INPUT => F[Option[PRINCIPAL]])(implicit eIsUnit: ERROR_OUTPUT =:= Unit): PartialServerEndpoint[A, PRINCIPAL, I, Unit, O, R, F]

Like serverSecurityLogic, but specialised to the case when the error type is Unit (e.g. a fixed status code), and the result of the logic function is an option. A None is then treated as an error response.

Like serverSecurityLogic, but specialised to the case when the error type is Unit (e.g. a fixed status code), and the result of the logic function is an option. A None is then treated as an error response.

Attributes

Inherited from:
EndpointServerLogicOps
def serverSecurityLogicOptionWithOutput[PRINCIPAL, F[_]](f: SECURITY_INPUT => F[Option[(OUTPUT, PRINCIPAL)]])(implicit eIsUnit: ERROR_OUTPUT =:= Unit): PartialServerEndpointWithSecurityOutput[A, PRINCIPAL, I, Unit, O, Unit, R, F]

Like serverSecurityLogicWithOutput, but specialised to the case when the error type is Unit (e.g. a fixed status code), and the result of the logic function is an option. A None is then treated as an error response.

Like serverSecurityLogicWithOutput, but specialised to the case when the error type is Unit (e.g. a fixed status code), and the result of the logic function is an option. A None is then treated as an error response.

Attributes

Inherited from:
EndpointServerLogicOps
def serverSecurityLogicPure[PRINCIPAL, F[_]](f: SECURITY_INPUT => Either[ERROR_OUTPUT, PRINCIPAL]): PartialServerEndpoint[A, PRINCIPAL, I, E, O, R, F]

Like serverSecurityLogic, but specialised to the case when the logic function is pure, that is doesn't have any side effects.

Like serverSecurityLogic, but specialised to the case when the logic function is pure, that is doesn't have any side effects.

Attributes

Inherited from:
EndpointServerLogicOps
def serverSecurityLogicPureWithOutput[PRINCIPAL, F[_]](f: SECURITY_INPUT => Either[ERROR_OUTPUT, (OUTPUT, PRINCIPAL)]): PartialServerEndpointWithSecurityOutput[A, PRINCIPAL, I, E, O, Unit, R, F]

Like serverSecurityLogicWithOutput, but specialised to the case when the logic function is pure, that is doesn't have any side effects.

Like serverSecurityLogicWithOutput, but specialised to the case when the logic function is pure, that is doesn't have any side effects.

Attributes

Inherited from:
EndpointServerLogicOps
def serverSecurityLogicRecoverErrors[PRINCIPAL, F[_]](f: SECURITY_INPUT => F[PRINCIPAL])(implicit eIsThrowable: ERROR_OUTPUT <:< Throwable, eClassTag: ClassTag[ERROR_OUTPUT]): PartialServerEndpoint[A, PRINCIPAL, I, E, O, R, F]

Same as serverSecurityLogic, but requires E to be a throwable, and converts failed effects of type E to endpoint errors.

Same as serverSecurityLogic, but requires E to be a throwable, and converts failed effects of type E to endpoint errors.

Attributes

Inherited from:
EndpointServerLogicOps
def serverSecurityLogicRecoverErrorsWithOutput[PRINCIPAL, F[_]](f: SECURITY_INPUT => F[(OUTPUT, PRINCIPAL)])(implicit eIsThrowable: ERROR_OUTPUT <:< Throwable, eClassTag: ClassTag[ERROR_OUTPUT]): PartialServerEndpointWithSecurityOutput[A, PRINCIPAL, I, E, O, Unit, R, F]

Same as serverSecurityLogicWithOutput, but requires E to be a throwable, and converts failed effects of type E to endpoint errors.

Same as serverSecurityLogicWithOutput, but requires E to be a throwable, and converts failed effects of type E to endpoint errors.

Attributes

Inherited from:
EndpointServerLogicOps
def serverSecurityLogicSuccess[PRINCIPAL, F[_]](f: SECURITY_INPUT => F[PRINCIPAL]): PartialServerEndpoint[A, PRINCIPAL, I, E, O, R, F]

Like serverSecurityLogic, but specialised to the case when the result is always a success (Right), hence when the logic type can be simplified to A => F[PRINCIPAL].

Like serverSecurityLogic, but specialised to the case when the result is always a success (Right), hence when the logic type can be simplified to A => F[PRINCIPAL].

Attributes

Inherited from:
EndpointServerLogicOps
def serverSecurityLogicSuccessWithOutput[PRINCIPAL, F[_]](f: SECURITY_INPUT => F[(OUTPUT, PRINCIPAL)]): PartialServerEndpointWithSecurityOutput[A, PRINCIPAL, I, E, O, Unit, R, F]

Like serverSecurityLogicWithOutput, but specialised to the case when the result is always a success (Right), hence when the logic type can be simplified to A => F[(O, PRINCIPAL)].

Like serverSecurityLogicWithOutput, but specialised to the case when the result is always a success (Right), hence when the logic type can be simplified to A => F[(O, PRINCIPAL)].

Attributes

Inherited from:
EndpointServerLogicOps
def serverSecurityLogicWithOutput[PRINCIPAL, F[_]](f: SECURITY_INPUT => F[Either[ERROR_OUTPUT, (OUTPUT, PRINCIPAL)]]): PartialServerEndpointWithSecurityOutput[A, PRINCIPAL, I, E, O, Unit, R, F]

Like serverSecurityLogic, but allows the security function to contribute to the overall output of the endpoint. A value for the complete output O defined so far has to be provided. The value PRINCIPAL will be propagated as an input to the regular logic.

Like serverSecurityLogic, but allows the security function to contribute to the overall output of the endpoint. A value for the complete output O defined so far has to be provided. The value PRINCIPAL will be propagated as an input to the regular logic.

Attributes

Inherited from:
EndpointServerLogicOps
def show: String

Basic information about the endpoint, excluding mapping information, with inputs sorted (first the method, then path, etc.). E.g.: POST /books /add {header Authorization} {body as application/json (UTF-8)} -> {body as text/plain (UTF-8)}/-

Basic information about the endpoint, excluding mapping information, with inputs sorted (first the method, then path, etc.). E.g.: POST /books /add {header Authorization} {body as application/json (UTF-8)} -> {body as text/plain (UTF-8)}/-

Attributes

Inherited from:
EndpointMetaOps
def showDetail: String

Detailed description of the endpoint, with inputs/outputs represented in the same order as originally defined, including mapping information. E.g.:

Detailed description of the endpoint, with inputs/outputs represented in the same order as originally defined, including mapping information. E.g.:

Endpoint(securityin: -, in: /books POST /add {body as application/json (UTF-8)} {header Authorization}, errout: {body as text/plain (UTF-8)}, out: -)

Attributes

Inherited from:
EndpointMetaOps
def showPathTemplate(showPathParam: (Int, PathCapture[_]) => String, showQueryParam: Option[(Int, Query[_]) => String], includeAuth: Boolean, showNoPathAs: String, showPathsAs: Option[String], showQueryParamsAs: Option[String]): String

Shows endpoint path, by default all parametrised path and query components are replaced by {param_name} or {paramN}, e.g. for

Shows endpoint path, by default all parametrised path and query components are replaced by {param_name} or {paramN}, e.g. for

endpoint.in("p1" / path[String] / query[String]("par2"))

returns /p1/{param1}?par2={par2}

Value parameters

includeAuth

Should authentication inputs be included in the result.

showNoPathAs

How to show the path if the endpoint does not define any path inputs.

showPathsAs

How to show Tapir.paths inputs (if at all), which capture multiple paths segments

showQueryParamsAs

How to show Tapir.queryParams inputs (if at all), which capture multiple query parameters

Attributes

Inherited from:
EndpointMetaOps
def showRaw: String

Equivalent to .toString, shows the whole case class structure.

Equivalent to .toString, shows the whole case class structure.

Attributes

Inherited from:
EndpointMetaOps
def showShort: String

Shortened information about the endpoint. If the endpoint is named, returns the name, e.g. [my endpoint]. Otherwise, returns the string representation of the method (if any) and path, e.g. POST /books/add

Shortened information about the endpoint. If the endpoint is named, returns the name, e.g. [my endpoint]. Otherwise, returns the string representation of the method (if any) and path, e.g. POST /books/add

Attributes

Inherited from:
EndpointMetaOps
def summary(s: String): ThisType[R]

Attributes

Inherited from:
EndpointInfoOps
def tag(t: String): ThisType[R]

Append t to the existing tags.

Append t to the existing tags.

Attributes

Inherited from:
EndpointInfoOps
def tags(ts: List[String]): ThisType[R]

Append ts to the existing tags.

Append ts to the existing tags.

Attributes

Inherited from:
EndpointInfoOps
def trace: EndpointType[A, I, E, O, R]

Attributes

Inherited from:
EndpointInputsOps
def withTag(t: String): ThisType[R]

Overwrite the existing tags with a single tag t.

Overwrite the existing tags with a single tag t.

Attributes

Inherited from:
EndpointInfoOps
def withTags(ts: List[String]): ThisType[R]

Overwrite the existing tags with ts.

Overwrite the existing tags with ts.

Attributes

Inherited from:
EndpointInfoOps

Remove all tags from this endpoint.

Remove all tags from this endpoint.

Attributes

Inherited from:
EndpointInfoOps