Qore Swagger Module Reference  2.0.8
Swagger::BodyParameter Class Reference

AbstractParameterObject specialization for "body" parameters. More...

Inheritance diagram for Swagger::BodyParameter:

Public Member Methods

 check (bool serialize, bool request, string path, string method, string name, reference value)
 verifies the parameter in an actual REST API call
 constructor (hash< auto > oh, SwaggerSchema swagger)
 Constructor. More...
string getQoreExample (reference< hash< RestQoreExampleCodeInfo >> rv)
 generates Qore example code for a REST API call
- Public Member Methods inherited from Swagger::AbstractParameterObject
 constructor (hash< auto > oh)
 Constructor. More...
auto getDefaultValue ()
 returns the default value of the parameter (default: NOTHING)
- Public Member Methods inherited from Swagger::ObjectBase
 constructor ()
 constructor (hash< auto > oh)
 Constructor. More...
 constructor (ObjectBase other)
 copy constructor
 initialize (hash< auto > oh)
 Initialize. More...

Public Attributes

SchemaObject schema
 Required. The schema defining the type used for the body parameter.
- Public Attributes inherited from Swagger::AbstractParameterObject
*string desc
 A brief description of the parameter. This could contain examples of use. GFM syntax can be used for rich text representation.
string inLoc
 Required. The location of the parameter. More...
string name
 Required. The name of the parameter. Parameter names are case sensitive. More...
bool required = False
 Determines whether this parameter is mandatory. More...
- Public Attributes inherited from Swagger::ObjectBase
hash< auto > vendorExtensions
 Allows extensions to the Swagger Schema. More...

Additional Inherited Members

- Static Public Member Methods inherited from Swagger::AbstractParameterObject
static AbstractParameterObject newParameter (string name, hash< auto > oh, SwaggerSchema swagger)
 gets a concrete instance of an AbstractParameterObject

Detailed Description

AbstractParameterObject specialization for "body" parameters.

Member Function Documentation

◆ constructor()

Swagger::BodyParameter::constructor ( hash< auto >  oh,
SwaggerSchema  swagger 


ohdeserialized hash from the source schema description describing a body parameter
swaggerthe REST schema for resolving references
INVALID-FIELD-TYPEfield has invalid type
REQUIRED-FIELD-MISSINGrequired field is missing