api-morph / ExternalDocumentationObject

Interface: ExternalDocumentationObject

Defined in: src/types/openapi.ts:505

Allows referencing an external resource for extended documentation.

See

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

Indexable

[key: `x-${string}`]: any

This object MAY be extended with Specification Extensions.

Properties

description?

optional description: string

Defined in: src/types/openapi.ts:509

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

---

url

url: string

Defined in: src/types/openapi.ts:514

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