 |
Qore Swagger Module Reference 2.1
|
|
Qore Swagger Module Reference 2.1
|
items schema object for non-body parameters More...
#include <Swagger.qm.dox.h>
Static Public Member Methods | |
| static ParameterItemsSchemaObject | newSchemaObject (string name, auto error, SwaggerSchema swagger) |
throws an "INVALID-FIELD-TYPE" exception More... | |
| static ParameterItemsSchemaObject | newSchemaObject (string name, hash< auto > oh, SwaggerSchema swagger) |
| returns a SchemaObject for the schema definition; resolves references More... | |
 Static Public Member Methods inherited from SchemaObject | |
| static SchemaObject | newSchemaObject (string name, auto error, SwaggerSchema swagger) |
throws an "INVALID-FIELD-TYPE" exception More... | |
| static SchemaObject | newSchemaObject (string name, hash< auto > oh, SwaggerSchema swagger) |
| returns a SchemaObject for the schema definition; resolves references More... | |
Public Attributes | |
| *string | collectionFormat |
| Determines the format of the array if type array is used. More... | |
| Public Attributes inherited from SchemaObject | |
| auto | additionalProperties |
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.4.4. More... | |
| auto | defaultVal |
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. | |
| *string | desc |
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.1. | |
| *string | discriminator |
| Adds support for polymorphism. More... | |
| auto | example |
| A free-form property to include an example of an instance for this schema. | |
| *ExternalDocumentationObject | externalDocs |
| Additional external documentation for this schema. | |
| *string | format |
The extending format for the previously mentioned type. See Data Type Formats for further details. | |
| *SchemaObject | items |
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.1. | |
| *int | maxProperties |
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.4.1. | |
| *int | minProperties |
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.4.2. | |
| string | name |
| the name of this object for documentation and example purposes | |
| bool | nullable = False |
| extension that allows types to be nullable More... | |
| hash< string, SchemaObject > | properties |
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.4.4. More... | |
| bool | readOnly = False |
Relevant only for Schema "properties" definitions. Declares the property as "read only". More... | |
| const | ReferenceTypes = ... |
| valid reference types | |
| hash< string, bool > | required |
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.4.3. More... | |
| const | ScalarTypes = ... |
| valid scalar types | |
| *string | title |
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.1. | |
| string | type |
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.2. More... | |
| *XmlObject | xml |
| This MAY be used only on properties schemas. It has no effect on root schemas. More... | |
Private Member Methods | |
| constructor (string name, hash< auto > oh, SwaggerSchema swagger) | |
| private constructor; use newSchemaObject() instead More... | |
| Private Member Methods inherited from SchemaObject | |
| check (bool serialize, bool request, string path, string method, string name, reference< auto > value) | |
| validates the value against the schema definition | |
| constructor(string name, hash< auto > oh, SwaggerSchema swagger, *string hash_str) public auto | getExampleValue () |
| private constructor; use newSchemaObject() instead More... | |
Additional Inherited Members | |
| Public Member Methods inherited from SchemaObject | |
| list< SchemaObject > | allOf () |
| See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.3. More... | |
| private | checkIntern (bool serialize, bool request, string type, *string format, string path, string method, string name, hash< auto > v, reference< hash< auto > > value) |
| validates a schema object against a value | |
| Static Private Member Methods inherited from SchemaObject | |
| static | checkValueType (reference< auto > value, string type, *SchemaObject items, *string loc) |
| validates default values | |
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 |
throws an "INVALID-FIELD-TYPE" exception
| INVALID-FIELD-TYPE | due to a type error in the call |
|
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 |
| *string 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".