Notarized
Notarization methods are the primary way that a Ktor API using Kompendium differentiates from a default Ktor application. On instantiation, a notarized route, provided with the proper metadata, will reflectively analyze all pertinent data to build a corresponding OpenAPI entry.
Functions
Link copied to clipboard
inline fun <TParam : Any, TResp : Any> Route.notarizedDelete(info: DeleteInfo<TParam, TResp>, postProcess: (PathOperation) -> PathOperation = { p -> p }, noinline body: PipelineInterceptor<Unit, ApplicationCall>): Route
Content copied to clipboard
Notarization for an HTTP DELETE request
Link copied to clipboard
inline fun <TParam : Any, TResp : Any> Route.notarizedGet(info: GetInfo<TParam, TResp>, postProcess: (PathOperation) -> PathOperation = { p -> p }, noinline body: PipelineInterceptor<Unit, ApplicationCall>): Route
Content copied to clipboard
Notarization for an HTTP GET request
Link copied to clipboard
inline fun <TParam : Any> Route.notarizedHead(info: HeadInfo<TParam>, postProcess: (PathOperation) -> PathOperation = { p -> p }, noinline body: PipelineInterceptor<Unit, ApplicationCall>): Route
Content copied to clipboard
Notarization for an HTTP HEAD request
Link copied to clipboard
inline fun <TParam : Any, TResp : Any> Route.notarizedOptions(info: OptionsInfo<TParam, TResp>, postProcess: (PathOperation) -> PathOperation = { p -> p }, noinline body: PipelineInterceptor<Unit, ApplicationCall>): Route
Content copied to clipboard
Notarization for an HTTP OPTION request
Link copied to clipboard
inline fun <TParam : Any, TReq : Any, TResp : Any> Route.notarizedPatch(info: PatchInfo<TParam, TReq, TResp>, postProcess: (PathOperation) -> PathOperation = { p -> p }, noinline body: PipelineInterceptor<Unit, ApplicationCall>): Route
Content copied to clipboard
Notarization for an HTTP PATCH request
Link copied to clipboard
inline fun <TParam : Any, TReq : Any, TResp : Any> Route.notarizedPost(info: PostInfo<TParam, TReq, TResp>, postProcess: (PathOperation) -> PathOperation = { p -> p }, noinline body: PipelineInterceptor<Unit, ApplicationCall>): Route
Content copied to clipboard
Notarization for an HTTP POST request
Link copied to clipboard
inline fun <TParam : Any, TReq : Any, TResp : Any> Route.notarizedPut(info: PutInfo<TParam, TReq, TResp>, postProcess: (PathOperation) -> PathOperation = { p -> p }, noinline body: PipelineInterceptor<Unit, ApplicationCall>): Route
Content copied to clipboard
Notarization for an HTTP PUT request