core/dev.akif.tapik/HttpEndpointVerbBuildingContext

HttpEndpointVerbBuildingContext

class HttpEndpointVerbBuildingContext(source)

First stage of the endpoint DSL, exposed before a method has been chosen.

Only verb-selection helpers live here. That restriction exists so every endpoint chooses its HTTP method and URI template before request and response details are added.

Functions

delete

fun delete(parameter: Parameter): HttpEndpointBuildingContext<Parameters1, Input<Headers0, EmptyBody>, Outputs0>

Starts a DELETE endpoint whose URI is built from a single parameter.

fun <P1 : Parameters> delete(uriWithParameters: URIWithParameters<P1>): HttpEndpointBuildingContext<P1, Input<Headers0, EmptyBody>, Outputs0>

Starts a DELETE endpoint from a precomposed URI template.

fun delete(path: String): HttpEndpointBuildingContext<Parameters0, Input<Headers0, EmptyBody>, Outputs0>

Starts a DELETE endpoint from a slash-separated literal path.

get

fun get(parameter: Parameter): HttpEndpointBuildingContext<Parameters1, Input<Headers0, EmptyBody>, Outputs0>

Starts a GET endpoint whose URI is built from a single parameter.

fun <P1 : Parameters> get(uriWithParameters: URIWithParameters<P1>): HttpEndpointBuildingContext<P1, Input<Headers0, EmptyBody>, Outputs0>

Starts a GET endpoint from a precomposed URI template.

fun get(path: String): HttpEndpointBuildingContext<Parameters0, Input<Headers0, EmptyBody>, Outputs0>

Starts a GET endpoint from a slash-separated literal path.

head

fun head(parameter: Parameter): HttpEndpointBuildingContext<Parameters1, Input<Headers0, EmptyBody>, Outputs0>

Starts a HEAD endpoint whose URI is built from a single parameter.

fun <P1 : Parameters> head(uriWithParameters: URIWithParameters<P1>): HttpEndpointBuildingContext<P1, Input<Headers0, EmptyBody>, Outputs0>

Starts a HEAD endpoint from a precomposed URI template.

fun head(path: String): HttpEndpointBuildingContext<Parameters0, Input<Headers0, EmptyBody>, Outputs0>

Starts a HEAD endpoint from a slash-separated literal path.

method

fun <P1 : Parameters> method(method: Method, uriWithParameters: URIWithParameters<P1>): HttpEndpointBuildingContext<P1, Input<Headers0, EmptyBody>, Outputs0>

Seeds the next builder stage with the chosen HTTP method and URI template.

options

fun options(parameter: Parameter): HttpEndpointBuildingContext<Parameters1, Input<Headers0, EmptyBody>, Outputs0>

Starts an OPTIONS endpoint whose URI is built from a single parameter.

fun <P1 : Parameters> options(uriWithParameters: URIWithParameters<P1>): HttpEndpointBuildingContext<P1, Input<Headers0, EmptyBody>, Outputs0>

Starts an OPTIONS endpoint from a precomposed URI template.

fun options(path: String): HttpEndpointBuildingContext<Parameters0, Input<Headers0, EmptyBody>, Outputs0>

Starts an OPTIONS endpoint from a slash-separated literal path.

patch

fun patch(parameter: Parameter): HttpEndpointBuildingContext<Parameters1, Input<Headers0, EmptyBody>, Outputs0>

Starts a PATCH endpoint whose URI is built from a single parameter.

fun <P1 : Parameters> patch(uriWithParameters: URIWithParameters<P1>): HttpEndpointBuildingContext<P1, Input<Headers0, EmptyBody>, Outputs0>

Starts a PATCH endpoint from a precomposed URI template.

fun patch(path: String): HttpEndpointBuildingContext<Parameters0, Input<Headers0, EmptyBody>, Outputs0>

Starts a PATCH endpoint from a slash-separated literal path.

post

fun post(parameter: Parameter): HttpEndpointBuildingContext<Parameters1, Input<Headers0, EmptyBody>, Outputs0>

Starts a POST endpoint whose URI is built from a single parameter.

fun <P1 : Parameters> post(uriWithParameters: URIWithParameters<P1>): HttpEndpointBuildingContext<P1, Input<Headers0, EmptyBody>, Outputs0>

Starts a POST endpoint from a precomposed URI template.

fun post(path: String): HttpEndpointBuildingContext<Parameters0, Input<Headers0, EmptyBody>, Outputs0>

Starts a POST endpoint from a slash-separated literal path.

put

fun put(parameter: Parameter): HttpEndpointBuildingContext<Parameters1, Input<Headers0, EmptyBody>, Outputs0>

Starts a PUT endpoint whose URI is built from a single parameter.

fun <P1 : Parameters> put(uriWithParameters: URIWithParameters<P1>): HttpEndpointBuildingContext<P1, Input<Headers0, EmptyBody>, Outputs0>

Starts a PUT endpoint from a precomposed URI template.

fun put(path: String): HttpEndpointBuildingContext<Parameters0, Input<Headers0, EmptyBody>, Outputs0>

Starts a PUT endpoint from a slash-separated literal path.

trace

fun trace(parameter: Parameter): HttpEndpointBuildingContext<Parameters1, Input<Headers0, EmptyBody>, Outputs0>

Starts a TRACE endpoint whose URI is built from a single parameter.

fun <P1 : Parameters> trace(uriWithParameters: URIWithParameters<P1>): HttpEndpointBuildingContext<P1, Input<Headers0, EmptyBody>, Outputs0>

Starts a TRACE endpoint from a precomposed URI template.

fun trace(path: String): HttpEndpointBuildingContext<Parameters0, Input<Headers0, EmptyBody>, Outputs0>

Starts a TRACE endpoint from a slash-separated literal path.