Skip to content

Latest commit

 

History

History
34 lines (18 loc) · 847 Bytes

openapi.OpenApiExternalDocumentation.md

File metadata and controls

34 lines (18 loc) · 847 Bytes

api-typescript-generator / Modules / openapi / OpenApiExternalDocumentation

Interface: OpenApiExternalDocumentation

openapi.OpenApiExternalDocumentation

Allows referencing an external resource for extended documentation.

See

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

Table of contents

Properties

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.