Qore Swagger Module Reference 2.4
Loading...
Searching...
No Matches
Swagger::FormDataParameter Class Reference

AbstractSwaggerParameterObject specialization for formData parameters More...

#include <Swagger.qm.dox.h>

Inheritance diagram for Swagger::FormDataParameter:
[legend]

Public Member Methods

void constructor (SwaggerSchema swagger, string name, hash< auto > oh)
 valid parameter types
 
void setType (SwaggerSchema swagger)
 Sets the parameter type.
 
- Public Member Methods inherited from Swagger::TypedParameter
auto getDefaultValue ()
 returns the default value of the parameter (default: NOTHING)
 
auto getExampleValue (*hash< string, bool > emap, *string fname)
 returns an example value of the parameter (default: NOTHING)
 
*RestSchemaValidator::AbstractSchemaObject getSchema ()
 Returns the schema for this parameter.
 
abstract void setType (SwaggerSchema swagger)
 Sets the parameter type.
 
- Public Member Methods inherited from Swagger::AbstractSwaggerParameterObject
abstract void check (reference value, string name, string method, string path, bool serialize, bool request)
 verifies the parameter in an actual REST API call
 
void constructor (hash< auto > oh, *int opt_flags)
 Constructor.
 
auto getDefaultValue ()
 returns the default value of the parameter (default: NOTHING)
 
abstract *RestSchemaValidator::AbstractSchemaObject getSchema ()
 Returns the schema for this parameter, if any.
 
- Public Member Methods inherited from Swagger::ObjectBase
void constructor ()
 Constructor.
 
void constructor (hash< auto > oh)
 Constructor.
 
void constructor (ObjectBase other)
 copy constructor
 
void initialize (hash< auto > oh)
 Initialize.
 
- Public Member Methods inherited from Swagger::SchemaBase
void checkIntern (reference value, binary v, string name, string method, string path, *string format, string type, bool serialize, bool request)
 converts binary values to strings for supported formats
 
void constructor ()
 Private constructor.
 
void constructor (SchemaBase other)
 Copy constructor.
 
void constructor (string objType, hash< auto > oh)
 Constructor.
 
auto getExampleValueWithFormat (*string fname, string type, *string format)
 returns an example value for the given type
 

Additional Inherited Members

- Static Public Member Methods inherited from Swagger::TypedParameter
static void checkValueType (*string loc, *SchemaObject items, reference< auto > value, string type)
 validates default values
 
- Static Public Member Methods inherited from Swagger::AbstractSwaggerParameterObject
static AbstractSwaggerParameterObject newParameter (SwaggerSchema swagger, string name, hash< auto > oh)
 gets a concrete instance of an AbstractSwaggerParameterObject
 
- Static Public Member Methods inherited from Swagger::SchemaBase
static void throwInvalidType (auto value, string expected, string name, string actual)
 throws an SCHEMA-VALIDATION-ERROR exception
 

Detailed Description

AbstractSwaggerParameterObject specialization for formData parameters