![]() |
Qore Swagger Module Reference
2.0.8
|
AbstractParameterObject specialization for "body"
parameters.
More...
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 | |
![]() | |
constructor (hash< auto > oh) | |
Constructor. More... | |
auto | getDefaultValue () |
returns the default value of the parameter (default: NOTHING) | |
![]() | |
constructor () | |
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. | |
![]() | |
*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... | |
![]() | |
hash< auto > | vendorExtensions |
Allows extensions to the Swagger Schema. More... | |
Additional Inherited Members | |
![]() | |
static AbstractParameterObject | newParameter (string name, hash< auto > oh, SwaggerSchema swagger) |
gets a concrete instance of an AbstractParameterObject | |
AbstractParameterObject specialization for "body"
parameters.
Swagger::BodyParameter::constructor | ( | hash< auto > | oh, |
SwaggerSchema | swagger | ||
) |
Constructor.
oh | deserialized hash from the source schema description describing a body parameter |
swagger | the REST schema for resolving references |
INVALID-FIELD-TYPE | field has invalid type |
REQUIRED-FIELD-MISSING | required field is missing |