Interface ExternalDocumentationObject

Allows referencing an external resource for extended documentation.

See

https://spec.openapis.org/oas/latest.html#external-documentation-object

interface ExternalDocumentationObject {
    description?: string;
    url: string;
}

Hierarchy (view full)

Properties

description? url

Properties

Optional description

description?: string

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

url

url: string

The URL for the target documentation. This MUST be in the form of a URL.

Settings

Member Visibility

Theme

On This Page

descriptionurl