/** * Allows referencing an external resource for extended documentation. * * ### External Documentation Object Example * * - Example with JSON ```json { "description": "Find more info here", "url": "https://example.com" } ``` * * - Example with YAML ```yaml description: Find more info here url: https://example.com ``` * * This object MAY be extended with [Specification Extensions][1]. * * [1]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#specification-extensions */ export interface ExternalDocumentationObject { /** * A description of the target documentation. * [CommonMark syntax][1] MAY be used for rich text representation. * * [1]: https://spec.commonmark.org/ */ description?: string; /** * The URL for the target documentation. This MUST be in the form of a URL. */ url: string; }