OpenAPIComponentContext

Types

abstract val headers: Map<String, Header>

abstract val parameters: Map<String, Parameter>

abstract val requestBodies: Map<String, RequestBody>

abstract val responses: Map<String, ApiResponse>

abstract val schemas: Map<String, Schema<*>>

abstract fun arraySchema(mainTargetType: Type, vararg typeParameters: Type): Schema<*>

abstract fun componentSchema(key: String, schema: Schema<*>): Schema<*>

Registers schema as the schema component key and returns a $ref to it.

abstract fun finish()

abstract fun header(key: String = "", builder: Header.() -> Unit): Header

abstract fun parameter(key: String = "", builder: Parameter.() -> Unit): Parameter

abstract fun requestBody(key: String = "", builder: RequestBodyBuilder.() -> Unit): RequestBody

abstract fun resolveType(mainTargetType: Type, vararg typeParameters: Type): ResolvedType

abstract fun response(key: String = "", builder: ApiResponseBuilder.() -> Unit): ApiResponse

abstract fun schema(mainTargetType: Type, vararg typeParameters: Type): Schema<*>