http4k-contract/org.http4k.contract.openapi.v3/ApiPath

ApiPath

sealed class ApiPath<NODE>

Inheritors

Types

class NoBody<NODE>(summary: String, description: String?, tags: List<String>?, parameters: List<RequestParameter<NODE>>, responses: Map<String, ResponseContents<NODE>>, security: NODE?, operationId: String?, deprecated: Boolean?, callbacks: Map<String, Map<Uri, Map<String, ApiPath<NODE>>>>?) : ApiPath<NODE>

class WithBody<NODE>(summary: String, description: String?, tags: List<String>?, parameters: List<RequestParameter<NODE>>, val requestBody: RequestContents<NODE>, responses: Map<String, ResponseContents<NODE>>, security: NODE?, operationId: String?, deprecated: Boolean?, callbacks: Map<String, Map<Uri, Map<String, ApiPath<NODE>>>>?) : ApiPath<NODE>

Properties

val callbacks: Map<String, Map<Uri, Map<String, ApiPath<NODE>>>>?

val deprecated: Boolean?

val description: String?

val operationId: String?

val parameters: List<RequestParameter<NODE>>

val responses: Map<String, ResponseContents<NODE>>

val security: NODE?

val summary: String

val tags: List<String>?

Functions

open fun definitions(): List<Pair<String, NODE>>