Package io.bkbn.kompendium.core.metadata

Houses all interfaces and types related to describing route metadata.

Types

Link copied to clipboard
data class ExceptionInfo<TResp : Any>(responseType: KType, status: HttpStatusCode, description: String, mediaTypes: List<String>, examples: Map<String, TResp>)
Link copied to clipboard
data class ParameterExample(parameterName: String, exampleName: String, exampleValue: Any)
Link copied to clipboard
data class RequestInfo<TReq>(description: String, required: Boolean, mediaTypes: List<String>, examples: Map<String, TReq>)
Link copied to clipboard
data class ResponseInfo<TResp>(status: HttpStatusCode, description: String, mediaTypes: List<String>, examples: Map<String, TResp>)
Link copied to clipboard
typealias SchemaMap = MutableMap<String, ComponentSchema>
Link copied to clipboard
typealias TypeMap = Map<KTypeParameter, KTypeProjection>