Package guru.zoroark.tegral.openapi.ktor.resources

Types

Link copied to clipboard
interface ResourceDescription

Provides endpoint descriptions for resource classes.

Functions

Link copied to clipboard
inline fun <T : Any> Route.deleteD(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route

Defines a delete route handler for the given resource, additionally registering its description.

Link copied to clipboard
fun describeResource(description: OperationDsl.() -> Unit): ResourceDescription

Function that should be used to implement ResourceDescription on resource classes.

Link copied to clipboard
inline fun <T : Any> descriptionFromCompanionObject(): OperationDsl.() -> Unit

Retrieves a resource description from the given class' companion object.

Link copied to clipboard
inline fun <T : Any> Route.getD(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route

Defines a get route handler for the given resource, additionally registering its description.

Link copied to clipboard
inline fun <T : Any> Route.headD(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route

Defines a head route handler for the given resource, additionally registering its description.

Link copied to clipboard
inline fun <T : Any> Route.optionsD(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route

Defines an options route handler for the given resource, additionally registering its description.

Link copied to clipboard
inline fun <T : Any> Route.patchD(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route

Defines a patch route handler for the given resource, additionally registering its description.

Link copied to clipboard
inline fun <T : Any> Route.postD(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route

Defines a post route handler for the given resource, additionally registering its description.

Link copied to clipboard
inline fun <T : Any> Route.putD(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route

Defines a put route handler for the given resource, additionally registering its description.