kompendium-oas/io.bkbn.kompendium.oas.common/ExternalDocumentation

ExternalDocumentation

data class ExternalDocumentation(val url: URI, val description: String?)

Allows referencing an external resource for extended documentation.

https://spec.openapis.org/oas/v3.1.0#external-documentation-object

Parameters

url

The URL for the target documentation.

description

A description of the target documentation.

Constructors

ExternalDocumentation

fun ExternalDocumentation(url: URI, description: String?)

Properties

val description: String?

val url: URI