Speakeasy Logo
Skip to Content

The OpenAPI External Documentation Object

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

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

Last updated on