core/dev.akif.tapik/HttpEndpointVerbBuildingContext

HttpEndpointVerbBuildingContext

class HttpEndpointVerbBuildingContext(source)

Interim building context exposed inside endpoint { } blocks before an HTTP verb is selected.

The DSL implementation only exposes HTTP verb helpers here so callers cannot mutate other metadata until they choose the method. Each helper returns a fully configured HttpEndpointBuildingContext that the rest of the builder can keep mutating.

Functions

delete

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

Creates a DELETE endpoint that uses a single parameter placeholder (path or query).

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

Creates a DELETE endpoint for the provided uriWithParameters.

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

Creates a DELETE endpoint by supplying a literal path.

get

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

Creates a GET endpoint that uses a single parameter placeholder (path or query).

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

Creates a GET endpoint for the provided uriWithParameters.

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

Creates a GET endpoint by supplying a literal path.

head

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

Creates a HEAD endpoint that uses a single parameter placeholder (path or query).

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

Creates a HEAD endpoint for the provided uriWithParameters.

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

Creates a HEAD endpoint by supplying a literal path.

method

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

Configures the HTTP verb and URI for the endpoint being declared.

options

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

Creates an OPTIONS endpoint that uses a single parameter placeholder (path or query).

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

Creates an OPTIONS endpoint for the provided uriWithParameters.

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

Creates an OPTIONS endpoint by supplying a literal path.

patch

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

Creates a PATCH endpoint that uses a single parameter placeholder (path or query).

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

Creates a PATCH endpoint for the provided uriWithParameters.

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

Creates a PATCH endpoint by supplying a literal path.

post

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

Creates a POST endpoint that uses a single parameter placeholder (path or query).

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

Creates a POST endpoint for the provided uriWithParameters.

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

Creates a POST endpoint by supplying a literal path.

put

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

Creates a PUT endpoint that uses a single parameter placeholder (path or query).

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

Creates a PUT endpoint for the provided uriWithParameters.

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

Creates a PUT endpoint by supplying a literal path.

trace

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

Creates a TRACE endpoint that uses a single parameter placeholder (path or query).

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

Creates a TRACE endpoint for the provided uriWithParameters.

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

Creates a TRACE endpoint by supplying a literal path.