wow-openapi/me.ahoo.wow.openapi.contract

Package-level declarations

Types

data class HttpContent(val mediaType: String, val schema: HttpSchema)

data class HttpHeader(val name: String, val schema: HttpSchema = HttpSchema.String, val description: String? = null, val componentRef: String? = null)

data class HttpParameter(val name: String, val location: HttpParameterLocation, val required: Boolean = false, val schema: HttpSchema = HttpSchema.String, val description: String? = null, val example: Any? = null, val componentRef: String? = null)

data class HttpRequestBody(val required: Boolean = false, val description: String? = null, val content: List<HttpContent> = emptyList(), val contentDeclared: Boolean = content.isNotEmpty(), val componentRef: String? = null)

data class HttpResponse(val statusCode: String, val description: String? = null, val headers: List<HttpHeader> = emptyList(), val content: List<HttpContent> = emptyList(), val contentDeclared: Boolean = content.isNotEmpty(), val componentRef: String? = null)

data class HttpRouteContract(val routeId: String, val method: String, val path: String, val handlerKey: String, val summary: String = "", val description: String = "", val pathSummary: String = summary, val pathDescription: String = description, val accept: List<String> = listOf("application/json"), val parameters: List<HttpParameter> = emptyList(), val requestBody: HttpRequestBody? = null, val responses: List<HttpResponse> = emptyList(), val tags: List<HttpTag> = emptyList(), val handlerMetadata: HttpRouteHandlerMetadata = HttpRouteHandlerMetadata.None)

sealed interface HttpSchema

data class HttpTag(val name: String, val description: String? = null)