ZPartialServerEndpoint
An endpoint with the security logic provided, and the main logic yet unspecified. See RichZEndpoint.zServerLogic.
The provided security part of the server logic transforms inputs of type A
, either to an error of type E
, or value of type U
.
The part of the server logic which is not provided, will have to transform a tuple: (U, I)
either into an error, or a value of type
O
.
Inputs/outputs can be added to partial endpoints as to regular endpoints, however the shape of the error outputs is fixed and cannot be changed. Hence, it's possible to create a base, secured input, and then specialise it with inputs, outputs and logic as needed.
- Type Params
- A
Type of the security inputs, transformed into U
- C
The capabilities that are required by this endpoint's inputs/outputs.
Any
, if no requirements.- E
Error output parameter types.
- I
Input parameter types.
- O
Output parameter types.
- U
Type of transformed security input.
Type members
Types
Value members
Concrete methods
Inherited methods
- Inherited from
- EndpointInputsOps
- Inherited from
- EndpointInputsMacros
- Inherited from
- EndpointOutputsMacros
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).
- Inherited from
- EndpointMetaOps
- Inherited from
- EndpointOutputsOps
- Inherited from
- EndpointOutputsOps
- Inherited from
- EndpointInputsOps
- Inherited from
- EndpointInputsOps
- Inherited from
- EndpointOutputsOps
- Inherited from
- EndpointOutputsOps
- Inherited from
- EndpointOutputsOps
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