![]() |
Qore Swagger Module Reference 2.2.3
|
describes a single HTTP header More...
Public Member Functions | |
| constructor (hash< auto > oh, SwaggerSchema swagger) | |
| Constructor. | |
Public Member Functions inherited from Swagger::ObjectBase | |
| constructor () | |
| Constructor. | |
| constructor (hash< auto > oh) | |
| Constructor. | |
| constructor (ObjectBase other) | |
| copy constructor | |
| initialize (hash< auto > oh) | |
| Initialize. | |
Public Member Functions inherited from Swagger::SchemaBase | |
| constructor (SchemaBase other) | |
| Copy constructor. | |
| constructor (string objType, hash< auto > oh) | |
| Constructor. | |
Static Protected Member Functions | |
| static | checkValueType (reference< auto > value, string type, *SchemaObject items, *string loc) |
| validates default values | |
Static Protected Member Functions inherited from Swagger::SchemaBase | |
| static | throwInvalidType (string name, string actual, string expected, auto value) |
throws an SCHEMA-VALIDATION-ERROR exception | |
Additional Inherited Members | |
Static Public Member Functions inherited from Swagger::SchemaBase | |
| static bool | checkValueType (reference< auto > value, string type) |
| Checks the value against the type. | |
Protected Member Functions inherited from Swagger::SchemaBase | |
| check (bool serialize, bool request, string type, *string format, *SchemaObject items, string path, string method, string name, reference< auto > value) | |
| validates the value against the schema definition | |
| checkArrayParam (bool serialize, bool request, SchemaObject items, string path, string method, string name, reference< list< auto > > value) | |
| validates the value against the schema definition | |
| checkIntern (bool serialize, bool request, string type, *string format, string path, string method, string name, binary v, reference value) | |
| converts binary values to strings for supported formats | |
| checkIntern (bool serialize, bool request, string type, *string format, string path, string method, string name, date v, reference< auto > value) | |
| converts dates to/from string or int values for supported formats | |
| checkIntern (bool serialize, bool request, string type, *string format, string path, string method, string name, string v, reference< auto > value) | |
| validates string values | |
| auto | getExampleValueWithFormat (string type, *string format, *string fname) |
| returns an example value for the given type | |
describes a single HTTP header
| Swagger::HeaderObject::constructor | ( | hash< auto > | oh, |
| SwaggerSchema | swagger ) |
Constructor.
| oh | deserialized hash from the source schema description describing a single HTTP header |
| swagger | the REST schema for resolving references |
| INVALID-FIELD-TYPE | field has invalid type |
| INVALID-FIELD-VALUE | field has invalid value |
| REQUIRED-FIELD-MISSING | required field is missing |
| *string Swagger::HeaderObject::collectionFormat |
Determines the format of the array if type array is used.
Possible values are:
"csv": comma separated values; ex: foo,bar"ssv": space separated values; ex: foo bar"tsv": tab separated values; ex: foo\tbar"pipes": pipe separated values; ex: foo|barDefault value is "csv".
| auto Swagger::HeaderObject::defaultVal |
Declares the value of the header that the server will use if none is provided.
(Note: "default" has no meaning for required headers.) See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined type for the header.
| string Swagger::HeaderObject::type |
Required. The type of the object.
The value MUST be one of "string", "number", "integer", "boolean", or "array".