External Documentation in OpenAPI best practices

The OpenAPI External Documentation Object

Allows for providing information about external documentation available for the API, Operation, Tag, or Schema.

Field

url

Type

String

Description

A URL to the external documentation.

Required

✅

description

Type

String

Description

A description of the external documentation. CommonMark syntax can be used to provide a rich description.

Required

x-*

Type

Extensions

Description

Any number of extension fields can be added to the external documentation object that can be used by tooling and vendors.

Required

Field	Type	Required	Description
url	String	✅	A URL to the external documentation.
description	String		A description of the external documentation. CommonMark syntax can be used to provide a rich description.
x-*	Extensions		Any number of extension fields can be added to the external documentation object that can be used by tooling and vendors.