tapir-core/sttp.tapir/EndpointMetaOps

EndpointMetaOps

trait EndpointMetaOps[I, E, O, -R]
class Object
trait Matchable
class Any
class Endpoint[I, E, O, R]
class PartialServerEndpoint[T, U, I, E, O, R, F]
class ServerEndpoint[I, E, O, R, F]
class ServerEndpointInParts[U, IR, I, E, O, R, F]

Type members

Types

type EndpointType[_I, _E, _O, -_R]

Value members

Abstract methods

protected def showType: String

Concrete methods

protected def additionalInputsForShow: Vector[Basic[_]]
def renderPathTemplate(renderPathParam: RenderPathParam, renderQueryParam: Option[RenderQueryParam], includeAuth: Boolean): String

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

Renders 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 Params
includeAuth

Should authentication inputs be included in the result.

def show: String

Basic information about the endpoint, excluding mapping information, with inputs sorted (first the method, then path, etc.)

Basic information about the endpoint, excluding mapping information, with inputs sorted (first the method, then path, etc.)

def showDetail: String

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

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

def showRaw: String

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

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