Qore Swagger Module Reference 2.2.1
Loading...
Searching...
No Matches
Swagger::ExternalDocumentationObject Class Reference

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

#include <Swagger.qm.dox.h>

Inheritance diagram for Swagger::ExternalDocumentationObject:
[legend]

Public Member Methods

 constructor (hash< auto > oh)
 Constructor. More...
 
- Public Member Methods inherited from Swagger::ObjectBase
 constructor ()
 Constructor.
 
 constructor (hash< auto > oh)
 Constructor. More...
 
 constructor (ObjectBase other)
 copy constructor
 
 initialize (hash< auto > oh)
 Initialize. 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.
 
- Public Attributes inherited from Swagger::ObjectBase
hash< auto > vendorExtensions
 Allows extensions to the Swagger Schema. More...
 

Detailed Description

Allows referencing an external resource for extended documentation.

Member Function Documentation

◆ constructor()

Swagger::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