wow-openapi/me.ahoo.wow.openapi.context/OpenAPIComponentContext

OpenAPIComponentContext

interface OpenAPIComponentContext : InlineSchemaCapable

Inheritors

DefaultOpenAPIComponentContext

Types

Companion

object Companion

Properties

headers

abstract val headers: Map<String, Header>

inline

abstract val inline: Boolean

parameters

abstract val parameters: Map<String, Parameter>

requestBodies

abstract val requestBodies: Map<String, RequestBody>

responses

abstract val responses: Map<String, ApiResponse>

schemas

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

Functions

acceptHeaderParameter

fun OpenAPIComponentContext.acceptHeaderParameter(): Parameter

aggregateIdHeaderParameter

fun OpenAPIComponentContext.aggregateIdHeaderParameter(): Parameter

aggregateVersionHeaderParameter

fun OpenAPIComponentContext.aggregateVersionHeaderParameter(): Parameter

arraySchema

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

badRequestCommandResponse

fun OpenAPIComponentContext.badRequestCommandResponse(): ApiResponse

badRequestResponse

fun OpenAPIComponentContext.badRequestResponse(): ApiResponse

batchAfterIdPathParameter

fun OpenAPIComponentContext.batchAfterIdPathParameter(): Parameter

batchLimitPathParameter

fun OpenAPIComponentContext.batchLimitPathParameter(): Parameter

batchResultResponse

fun OpenAPIComponentContext.batchResultResponse(): ApiResponse

batchResultSchema

fun OpenAPIComponentContext.batchResultSchema(): Schema<*>

commandAggregateContextHeaderParameter

fun OpenAPIComponentContext.commandAggregateContextHeaderParameter(): Parameter

commandAggregateNameHeaderParameter

fun OpenAPIComponentContext.commandAggregateNameHeaderParameter(): Parameter

commandCommonHeaderParameters

fun OpenAPIComponentContext.commandCommonHeaderParameters(): List<Parameter>

commandResponses

fun OpenAPIComponentContext.commandResponses(): ApiResponses

commandResultSchema

fun OpenAPIComponentContext.commandResultSchema(): Schema<*>

commandTypeHeaderParameter

fun OpenAPIComponentContext.commandTypeHeaderParameter(): Parameter

compensationTargetRequestBody

fun OpenAPIComponentContext.compensationTargetRequestBody(): RequestBody

compensationTargetResponse

fun OpenAPIComponentContext.compensationTargetResponse(): ApiResponse

compensationTargetSchema

fun OpenAPIComponentContext.compensationTargetSchema(): Schema<*>

conditionSchema

fun OpenAPIComponentContext.conditionSchema(): Schema<*>

countQueryRequestBody

fun OpenAPIComponentContext.countQueryRequestBody(): RequestBody

countQueryResponse

fun OpenAPIComponentContext.countQueryResponse(): ApiResponse

createTimePathParameter

fun OpenAPIComponentContext.createTimePathParameter(): Parameter

errorCodeHeader

fun OpenAPIComponentContext.errorCodeHeader(): Header

errorInfoSchema

fun OpenAPIComponentContext.errorInfoSchema(): Schema<*>

finish

abstract fun finish()

header

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

headVersionPathParameter

fun OpenAPIComponentContext.headVersionPathParameter(): Parameter

idPathParameter

fun OpenAPIComponentContext.idPathParameter(): Parameter

illegalAccessDeletedAggregateCommandResponse

fun OpenAPIComponentContext.illegalAccessDeletedAggregateCommandResponse(): ApiResponse

listQueryRequestBody

fun OpenAPIComponentContext.listQueryRequestBody(): RequestBody

listQuerySchema

fun OpenAPIComponentContext.listQuerySchema(): Schema<*>

loadAggregateResponses

fun OpenAPIComponentContext.loadAggregateResponses(summary: String, aggregateMetadata: AggregateMetadata<*, *>): ApiResponses

loadEventStreamResponse

fun OpenAPIComponentContext.loadEventStreamResponse(aggregateMetadata: AggregateMetadata<*, *>): ApiResponse

localFirstHeaderParameter

fun OpenAPIComponentContext.localFirstHeaderParameter(): Parameter

notFoundCommandResponse

fun OpenAPIComponentContext.notFoundCommandResponse(): ApiResponse

notFoundResponse

fun OpenAPIComponentContext.notFoundResponse(): ApiResponse

okCommandResponse

fun OpenAPIComponentContext.okCommandResponse(): ApiResponse

ownerIdHeaderParameter

fun OpenAPIComponentContext.ownerIdHeaderParameter(): Parameter

ownerIdPathParameter

fun OpenAPIComponentContext.ownerIdPathParameter(): Parameter

pagedListEventStreamResponse

fun OpenAPIComponentContext.pagedListEventStreamResponse(aggregateMetadata: AggregateMetadata<*, *>): ApiResponse

pagedQueryRequestBody

fun OpenAPIComponentContext.pagedQueryRequestBody(): RequestBody

pagedQuerySchema

fun OpenAPIComponentContext.pagedQuerySchema(): Schema<*>

parameter

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

requestBody

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

requestIdHeaderParameter

fun OpenAPIComponentContext.requestIdHeaderParameter(): Parameter

requestTimeoutCommandResponse

fun OpenAPIComponentContext.requestTimeoutCommandResponse(): ApiResponse

requestTimeoutResponse

fun OpenAPIComponentContext.requestTimeoutResponse(): ApiResponse

resolveType

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

response

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

schema

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

singleQueryRequestBody

fun OpenAPIComponentContext.singleQueryRequestBody(): RequestBody

singleQuerySchema

fun OpenAPIComponentContext.singleQuerySchema(): Schema<*>

tailVersionPathParameter

fun OpenAPIComponentContext.tailVersionPathParameter(): Parameter

tenantIdHeaderParameter

fun OpenAPIComponentContext.tenantIdHeaderParameter(): Parameter

tenantIdPathParameter

fun OpenAPIComponentContext.tenantIdPathParameter(): Parameter

tooManyRequestsCommandResponse

fun OpenAPIComponentContext.tooManyRequestsCommandResponse(): ApiResponse

tooManyRequestsResponse

fun OpenAPIComponentContext.tooManyRequestsResponse(): ApiResponse

versionConflictCommandResponse

fun OpenAPIComponentContext.versionConflictCommandResponse(): ApiResponse

versionPathParameter

fun OpenAPIComponentContext.versionPathParameter(): Parameter

waitContextHeaderParameter

fun OpenAPIComponentContext.waitContextHeaderParameter(): Parameter

waitProcessorHeaderParameter

fun OpenAPIComponentContext.waitProcessorHeaderParameter(): Parameter

waitStageHeaderParameter

fun OpenAPIComponentContext.waitStageHeaderParameter(): Parameter

waitTimeOutHeaderParameter

fun OpenAPIComponentContext.waitTimeOutHeaderParameter(): Parameter