main.io.github.smiley4.ktorswaggerui.data.ExternalDocsData.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 - External Documentation Object](https://swagger.io/specification/#external-documentation-object).
 */
data class ExternalDocsData(
    val url: String,
    val description: String?,
) {

    companion object {
        val DEFAULT = ExternalDocsData(
            url = "/",
            description = null
        )
    }

}