kompendium-oas/io.bkbn.kompendium.oas.payload

Package io.bkbn.kompendium.oas.payload

This is another good one, this is where the actual payload types live. Request and response body specifications, parameter details, collection support. That all lives here.

Types

AnyOfPayload

data class AnyOfPayload(anyOf: List<ComponentSchema>) : Payload

MediaType

data class MediaType(schema: ComponentSchema, examples: Map<String, MediaType.Example>?)

Parameter

data class Parameter(name: String, in: String, schema: ComponentSchema, description: String?, required: Boolean, deprecated: Boolean, allowEmptyValue: Boolean?, style: String?, explode: Boolean?, examples: Map<String, Parameter.Example>?)

Payload

interface Payload

Request

data class Request(description: String?, content: Map<String, MediaType>, required: Boolean) : Payload

Response

data class Response(description: String?, headers: Map<String, Payload>?, content: Map<String, MediaType>?, links: Map<String, Payload>?) : Payload