An Endpoint together with functions implementing the endpoint's security and main logic.
- Type Params
- F
The effect type used in the provided server logic.
- R
Requirements: The capabilities that are required by this endpoint's inputs/outputs.
Any, if no requirements.
- Companion
- object
Type members
Types
"User": The type of the value returned by the security logic.
"User": The type of the value returned by the security logic.
Value members
Abstract methods
Concrete methods
Inherited methods
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.
- Inherited from
- EndpointMetaOps
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.)
- Inherited from
- EndpointMetaOps
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.
- Inherited from
- EndpointMetaOps
Equivalent to .toString, shows the whole case class structure.
Equivalent to .toString, shows the whole case class structure.
- Inherited from
- EndpointMetaOps