tegral-openapi-ktor-resources/guru.zoroark.tegral.openapi.ktor.resources

Package-level declarations

Types

Link copied to clipboard
typealias OperationSelector = PathDsl.() -> OperationBuilder?

This type is intended to be used in a lambda calling one of the HTTP method properties of PathDsl, such as PathDsl.get, PathDsl.post, etc.

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: PathDsl.() -> Unit): ResourceDescription

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

Link copied to clipboard
inline fun <T : Any> descriptionFromResource(noinline operationSelector: OperationSelector): OperationBuilderWithHooks
fun <T : Any> descriptionFromResource(resourceClass: KClass<T>, operationSelector: OperationSelector): OperationBuilderWithHooks

Create a description from the information contained in the resource T.

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.