Qore Swagger Module Reference  1.0.2
Swagger::ResponsesObject Class Reference

contains the possible responses for an operation More...

Inheritance diagram for Swagger::ResponsesObject:

Public Member Functions

 constructor (string path, string method, hash oh, SwaggerSchema swagger)
 Constructor. More...
 
- Public Member Functions inherited from Swagger::ObjectBase
 constructor ()
 Constructor.
 
 constructor (hash oh)
 Constructor. More...
 
 constructor (ObjectBase other)
 copy constructor
 
 initialize (hash oh)
 Initialize. More...
 

Public Attributes

ResponseObject defaultResp
 
hash< string, ResponseObjectresponses
 
- Public Attributes inherited from Swagger::ObjectBase
hash vendorExtensions
 Allows extensions to the Swagger Schema. More...
 

Detailed Description

contains the possible responses for an operation

Member Function Documentation

◆ constructor()

Swagger::ResponsesObject::constructor ( string  path,
string  method,
hash  oh,
SwaggerSchema  swagger 
)

Constructor.

Parameters
paththe URI path for the operation
methodthe HTTP method for the operation
ohdeserialized hash from the source schema description describing the responses for an operation
swaggerthe REST schema for resolving references
Exceptions
INVALID-FIELD-TYPEfield has invalid type
REQUIRED-FIELD-MISSINGrequired field is missing
EMPTY-RESPONSESno responses given

Member Data Documentation

◆ defaultResp

ResponseObject Swagger::ResponsesObject::defaultResp

It can be used to cover undeclared responses.

◆ responses

hash<string, ResponseObject> Swagger::ResponsesObject::responses

Any HTTP status code can be used as the property name (one property per HTTP status code). Describes the expected response for that HTTP status code.