Qore Swagger Module Reference 2.1.1
Loading...
Searching...
No Matches
ExternalDocumentationObject Class Reference

Allows referencing an external resource for extended documentation. More...

#include <Swagger.qm.dox.h>

Inherits ObjectBase.

Public Member Methods

 constructor (hash< auto > oh)
 Constructor. More...
 

Public Attributes

*string desc
 A short description of the target documentation. GFM syntax can be used for rich text representation.
 
string url
 Required. The URL for the target documentation. Value MUST be in the format of a URL.
 

Detailed Description

Allows referencing an external resource for extended documentation.

Member Function Documentation

◆ constructor()

ExternalDocumentationObject::constructor ( hash< auto >  oh)

Constructor.

Parameters
ohdeserialized hash from the source schema description providing a reference to external documentation
Exceptions
INVALID-FIELD-TYPEfield has invalid type
REQUIRED-FIELD-MISSINGrequired field is missing