mirror of
https://github.com/LukeHagar/openapi-types.git
synced 2025-12-09 12:37:47 +00:00
Prettier formatting
This commit is contained in:
@@ -84,36 +84,36 @@ import type { Extension } from "./extensions";
|
||||
* ```
|
||||
*/
|
||||
export interface ExternalDocumentation extends Extension {
|
||||
/**
|
||||
* A short description of the target documentation. GFM syntax can be used for
|
||||
* rich text representation.
|
||||
*
|
||||
* This description provides context about what the external documentation
|
||||
* contains and helps developers understand when and why they should
|
||||
* reference it.
|
||||
*
|
||||
* @see {@link https://swagger.io/specification/v2/#external-documentation-object | Swagger 2.0 Specification - description}
|
||||
*
|
||||
* @example "Find more info here"
|
||||
* @example "Complete API documentation with examples and tutorials"
|
||||
* @example "SDK documentation and code examples"
|
||||
* @example "Step-by-step integration guide"
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* A short description of the target documentation. GFM syntax can be used for
|
||||
* rich text representation.
|
||||
*
|
||||
* This description provides context about what the external documentation
|
||||
* contains and helps developers understand when and why they should
|
||||
* reference it.
|
||||
*
|
||||
* @see {@link https://swagger.io/specification/v2/#external-documentation-object | Swagger 2.0 Specification - description}
|
||||
*
|
||||
* @example "Find more info here"
|
||||
* @example "Complete API documentation with examples and tutorials"
|
||||
* @example "SDK documentation and code examples"
|
||||
* @example "Step-by-step integration guide"
|
||||
*/
|
||||
description?: string;
|
||||
|
||||
/**
|
||||
* The URL for the target documentation. Value MUST be in the format of a URL.
|
||||
* This field is required.
|
||||
*
|
||||
* The URL should point to a valid, accessible resource that provides
|
||||
* additional documentation about the API or specific aspects of it.
|
||||
*
|
||||
* @see {@link https://swagger.io/specification/v2/#external-documentation-object | Swagger 2.0 Specification - url}
|
||||
*
|
||||
* @example "https://swagger.io"
|
||||
* @example "https://docs.example.com/api"
|
||||
* @example "https://github.com/example/sdk"
|
||||
* @example "https://example.com/integration-guide"
|
||||
*/
|
||||
url: string;
|
||||
/**
|
||||
* The URL for the target documentation. Value MUST be in the format of a URL.
|
||||
* This field is required.
|
||||
*
|
||||
* The URL should point to a valid, accessible resource that provides
|
||||
* additional documentation about the API or specific aspects of it.
|
||||
*
|
||||
* @see {@link https://swagger.io/specification/v2/#external-documentation-object | Swagger 2.0 Specification - url}
|
||||
*
|
||||
* @example "https://swagger.io"
|
||||
* @example "https://docs.example.com/api"
|
||||
* @example "https://github.com/example/sdk"
|
||||
* @example "https://example.com/integration-guide"
|
||||
*/
|
||||
url: string;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user