ktor-openapi-schema/io.ktor.openapi/ExternalDocs

ExternalDocs

data class ExternalDocs(val description: String? = null, val url: String)(source)

Allows referencing an external resource for extended documentation.

Report a problem

Constructors

constructor(description: String? = null, url: String)

Properties

val description: String?

A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.

val url: String

The URL for the target documentation. Value MUST be in the format of a URL.