main.io.github.smiley4.ktorswaggerui.data.SecuritySchemeData.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ktor-swagger-ui Show documentation

Ktor plugin to document routes and provide a Swagger-UI

There is a newer version: 3.4.0

package io.github.smiley4.ktorswaggerui.data

/**
 * See [OpenAPI Specification - Security Scheme Object](https://swagger.io/specification/#security-scheme-object).
 */
data class SecuritySchemeData(
    val schemeName: String,
    val type: AuthType?,
    val name: String?,
    val location: AuthKeyLocation?,
    val scheme: AuthScheme?,
    val bearerFormat: String?,
    val flows: OpenIdOAuthFlowsData?,
    val openIdConnectUrl: String?,
    val description: String?
) {

    companion object {
        val DEFAULT = SecuritySchemeData(
            schemeName = "",
            type = null,
            name = null,
            location = null,
            scheme = null,
            bearerFormat = null,
            flows = null,
            openIdConnectUrl = null,
            description = null,
        )
    }

}