|
Qore Swagger Module Reference
1.0.1
|
items schema object for non-body parameters More...

Static Public Member Functions | |
| static ParameterItemsSchemaObject | newSchemaObject (string name, hash oh, SwaggerSchema swagger) |
| returns a SchemaObject for the schema definition; resolves references More... | |
| static ParameterItemsSchemaObject | newSchemaObject (string name, auto error, SwaggerSchema swagger) |
throws an "INVALID-FIELD-TYPE" exception More... | |
Static Public Member Functions inherited from Swagger::SchemaObject | |
| static SchemaObject | newSchemaObject (string name, hash oh, SwaggerSchema swagger) |
| returns a SchemaObject for the schema definition; resolves references More... | |
| static SchemaObject | newSchemaObject (string name, auto error, SwaggerSchema swagger) |
throws an "INVALID-FIELD-TYPE" exception More... | |
Private Member Functions | |
| constructor (string name, hash oh, SwaggerSchema swagger) | |
| private constructor; use newSchemaObject() instead More... | |
Additional Inherited Members | |
Public Member Functions inherited from Swagger::SchemaObject | |
| list< SchemaObject > | allOf () |
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.3. More... | |
| check (bool serialize, bool request, string path, string method, string name, reference value) | |
| validates the value against the schema definition | |
| string | getQoreExample (reference< hash< RestQoreExampleCodeInfo >> rv, string name, bool decl) |
| returns example Qore code for the object | |
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 Member Functions inherited from Swagger::SchemaBase | |
| constructor (string objType, hash oh) | |
| Constructor. More... | |
| constructor (SchemaBase other) | |
| Copy constructor. | |
items schema object for non-body parameters
|
private |
private constructor; use newSchemaObject() instead
| name | the name of the object |
| oh | deserialized hash from the source schema description describing an object in the schema |
| swagger | the REST schema for resolving references |
| INVALID-FIELD-FORMAT | field has invalid format |
| INVALID-FIELD-TYPE | field has invalid type |
| INVALID-FIELD-VALUE | field has invalid value |
| INVALID-COLLECTION-FORMAT | invalid collectionFormat value |
| INVALID-REFERENCE | cannot resolve reference; unknown attributes in description |
| REQUIRED-FIELD-MISSING | required field is missing |
|
static |
returns a SchemaObject for the schema definition; resolves references
| name | the name of the object |
| oh | deserialized hash from the source schema description describing an object in the schema |
| swagger | the REST schema for resolving references |
| INVALID-FIELD-FORMAT | field has invalid format |
| INVALID-FIELD-TYPE | field has invalid type |
| INVALID-FIELD-VALUE | field has invalid value |
| INVALID-COLLECTION-FORMAT | invalid collectionFormat value |
| INVALID-REFERENCE | cannot resolve reference; unknown attributes in description |
| REQUIRED-FIELD-MISSING | required field is missing |
|
static |
throws an "INVALID-FIELD-TYPE" exception
| INVALID-FIELD-TYPE | due to a type error in the call |
| *string Swagger::ParameterItemsSchemaObject::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|bar"multi": corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz. This is valid only for parameters in "query" or "formData".Default value is "csv".