[api-typescript-generator](../../README.md) / [Modules](../modules.md) / [openapi](../modules/openapi.md) / OpenApiExternalDocumentation

# Interface: OpenApiExternalDocumentation

[openapi](../modules/openapi.md).OpenApiExternalDocumentation

Allows referencing an external resource for extended documentation.

**`See`**

https://swagger.io/specification/#external-documentation-object

## Table of contents

### Properties

- [description](openapi.OpenApiExternalDocumentation.md#description)
- [url](openapi.OpenApiExternalDocumentation.md#url)

## Properties

### description

• `Optional` **description**: `string`

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

___

### url

• **url**: `string`

The URL for the target documentation. Value MUST be in the format of a URL.