PartialServerEndpoint
An endpoint with the security logic provided, and the main logic yet unspecified. See Endpoint.serverSecurityLogic.
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 both U and the rest of the input I either into an error,
or a value of type O.
Inputs/outputs can be added to partial endpoints as to regular endpoints. The shape of the error outputs can be adjusted in a limited
way, by adding new error output variants, similar as if they were defined using Tapir.oneOf; the variants and the existing error
outputs should usually have a common supertype (other than Any). Hence, it's possible to create a base, secured input, and then
specialise it with inputs, outputs and logic as needed.
- Type Params
- A
"Auth": Security input parameter types, which the security logic accepts and returns a
Uor an errorE.- E
Error output parameter types.
- F
The effect type used in the provided partial server logic.
- I
Input parameter types.
- O
Output parameter types.
- R
The capabilities that are required by this endpoint's inputs/outputs.
Any, if no requirements.- U
"User": The type of the value returned by the security logic.
Type members
Types
Value members
Concrete methods
Inherited methods
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.
- Inherited from
- EndpointErrorOutputVariantsOps
Adds a new error output variant. The new variant will be checked first during encoding/decoding, before the endpoint's current output.
Adds a new error output variant. The new variant will be checked first during encoding/decoding, before the endpoint's current output.
More specifically, the current error output is replaced with a Tapir.oneOf output, where:
- the first output variant is the given
o - the second output variant is the current
errorOutput, wrapped with Tapir.oneOfDefaultVariant
- Type Params
- E2
A common supertype of the new variant and the current output
E.
- Value Params
- o
The variant to add. Can be created given an output with one of the Tapir.oneOfVariant methods.
- Inherited from
- EndpointErrorOutputVariantsOps
Adds a new error variant, where the current error output is mapped to conform to the common supertype E2 using the f and g
functions.
Adds a new error variant, where the current error output is mapped to conform to the common supertype E2 using the f and g
functions.
- Inherited from
- EndpointErrorOutputVariantsOps
Adds new error output variants. The new variants will be checked first during encoding/decoding, before the endpoint's current output.
Adds new error output variants. The new variants will be checked first during encoding/decoding, before the endpoint's current output.
More specifically, the current error output is replaced with a Tapir.oneOf output, where:
- the initial output variants are the given
firstandother - the last output variant is the current
errorOutput, wrapped with Tapir.oneOfDefaultVariant
- Type Params
- E2
A common supertype of the new variant and the current output
E.
- Value Params
- first
The first variant to add. Can be created given an output with one of the Tapir.oneOfVariant methods.
- other
Additional variants to add.
- Inherited from
- EndpointErrorOutputVariantsOps
Adds new error variants, where the current error output is mapped to conform to the common supertype E2 using the f and g
functions.
Adds new error variants, where the current error output is mapped to conform to the common supertype E2 using the f and g
functions.
- Inherited from
- EndpointErrorOutputVariantsOps
- Inherited from
- EndpointInputsOps
- Inherited from
- EndpointInputsMacros
- Inherited from
- EndpointOutputsMacros
- 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
Equivalent to .toString, shows the whole case class structure.
Equivalent to .toString, shows the whole case class structure.
- Inherited from
- EndpointMetaOps