Package-level declarations
Types
Link copied to clipboard
class ContractBuilder
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class ContractRouteSpec8<out A, out B, out C, out D, out E, out F, out G, out H> : ContractRouteSpec
Link copied to clipboard
Link copied to clipboard
data class ContractRoutingHttpHandler(renderer: ContractRenderer, security: Security?, tags: Set<Tag>, descriptionSecurity: Security?, descriptionPath: String, preFlightExtraction: PreFlightExtraction, routes: List<ContractRoute> = emptyList(), rootAsString: String = "", preSecurityFilter: Filter = Filter.NoOp, postSecurityFilter: Filter = Filter.NoOp, includeDescriptionRoute: Boolean = false, webhooks: Map<String, List<WebCallback>> = emptyMap()) : RoutingHttpHandler
Link copied to clipboard
interface ErrorResponseRenderer
Link copied to clipboard
open class HttpMessageMeta<out T : HttpMessage>(val message: T, val description: String, val definitionId: String?, val example: Any?, val schemaPrefix: String? = null)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Determines which parts of the request should be pre-extracted to check for presence before being passed to the ultimate HttpHandler for this route. Choice will be determined by two competing scenarios:
Link copied to clipboard
class RequestMeta(request: Request, definitionId: String? = null, example: Any? = null, schemaPrefix: String? = null) : HttpMessageMeta<Request>
Link copied to clipboard
class ResponseMeta(description: String, response: Response, definitionId: String? = null, example: Any? = null, schemaPrefix: String? = null) : HttpMessageMeta<Response>
Link copied to clipboard
Link copied to clipboard
data class RouteMeta(val summary: String = "<unknown>", val description: String? = null, val tags: Set<Tag> = emptySet(), val body: BodyLens<*>? = null, val produces: Set<ContentType> = emptySet(), val consumes: Set<ContentType> = emptySet(), val requestParams: List<Lens<Request, *>> = emptyList(), val requests: List<HttpMessageMeta<Request>> = emptyList(), val responses: List<HttpMessageMeta<Response>> = emptyList(), val preFlightExtraction: PreFlightExtraction? = null, val security: Security? = null, val operationId: String? = null, val deprecated: Boolean = false, val callbacks: Map<String, Map<Uri, WebCallback>>? = null, val described: Boolean = true)
Link copied to clipboard
class RouteMetaDsl
Link copied to clipboard
Link copied to clipboard
Functions
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
infix fun <A, B, C, D, E, F, G, H, I, J> ContractRouteSpec10<A, B, C, D, E, F, G, H, I, J>.meta(new: RouteMetaDsl.() -> Unit): ContractRouteSpec10<A, B, C, D, E, F, G, H, I, J>
infix fun <A, B> ContractRouteSpec2<A, B>.meta(new: RouteMetaDsl.() -> Unit): ContractRouteSpec2<A, B>
infix fun <A, B, C> ContractRouteSpec3<A, B, C>.meta(new: RouteMetaDsl.() -> Unit): ContractRouteSpec3<A, B, C>
infix fun <A, B, C, D> ContractRouteSpec4<A, B, C, D>.meta(new: RouteMetaDsl.() -> Unit): ContractRouteSpec4<A, B, C, D>
infix fun <A, B, C, D, E> ContractRouteSpec5<A, B, C, D, E>.meta(new: RouteMetaDsl.() -> Unit): ContractRouteSpec5<A, B, C, D, E>
infix fun <A, B, C, D, E, F> ContractRouteSpec6<A, B, C, D, E, F>.meta(new: RouteMetaDsl.() -> Unit): ContractRouteSpec6<A, B, C, D, E, F>
infix fun <A, B, C, D, E, F, G> ContractRouteSpec7<A, B, C, D, E, F, G>.meta(new: RouteMetaDsl.() -> Unit): ContractRouteSpec7<A, B, C, D, E, F, G>
infix fun <A, B, C, D, E, F, G, H> ContractRouteSpec8<A, B, C, D, E, F, G, H>.meta(new: RouteMetaDsl.() -> Unit): ContractRouteSpec8<A, B, C, D, E, F, G, H>
Link copied to clipboard
Link copied to clipboard