189 "serialize": \make_json(),
190 "serialize_verbose":
string (
auto val) {
return make_json(val, JGF_ADD_FORMATTING);},
191 "deserialize": \parse_json(),
195 "serialize": \make_yaml(),
196 "serialize_verbose":
string (
auto val) {
return make_yaml(val, BlockStyle);},
197 "deserialize": \parse_yaml(),
295 hash<string, bool>
enum;
323 check(
bool serialize,
bool request,
string type, *
string format, *
SchemaObject items,
string path,
string method,
string name, reference value);
329 checkStringIntern(
string path,
string method,
string name,
string value);
335 checkIntern(
bool serialize,
bool request,
string type, *
string format,
string path,
string method,
string name,
int v, reference<int> value);
342 checkIntern(
bool serialize,
bool request,
string type, *
string format,
string path,
string method,
string name,
number v, reference<number> value);
349 checkIntern(
bool serialize,
bool request,
string type, *
string format,
string path,
string method,
string name,
binary v, reference value);
356 checkIntern(
bool serialize,
bool request,
string type, *
string format,
string path,
string method,
string name,
string v, reference value);
363 checkIntern(
bool serialize,
bool request,
string type, *
string format,
string path,
string method,
string name,
date v, reference value);
369 checkIntern(
bool serialize,
bool request,
string type, *
string format,
string path,
string method,
string name,
bool v, reference<bool> value);
375 checkIntern(
bool serialize,
bool request,
string type, *
string format,
string path,
string method,
string name, nothing v, reference<nothing> value);
382 checkArrayParam(
bool serialize,
bool request,
SchemaObject items,
string path,
string method,
string name, reference<softlist> value);
499 hash<string, AbstractParameterObject>
parameters();
544 "compact_serialization":
True,
630 hash<RestSchemaValidator::RestRequestClientInfo>
processRequestImpl(
string method,
string path,
auto body, *
hash headers, *softlist<string> content_types);
646 hash<RestSchemaValidator::RestRequestServerInfo>
parseRequestImpl(
string method,
string path, *data http_body, reference<hash> headers);
668 hash<HttpResponseInfo>
processResponseImpl(
string method,
string path,
int code,
auto response_body, *
hash headers, *softlist<string> content_types);
685 hash<RestSchemaValidator::RestResponseClientInfo>
parseResponseImpl(
string method,
string path,
int code, *data response_body,
hash hdr);
737 hash<RestSchemaValidator::RestExampleRequestInfo>
getExampleRequestImpl(
string method,
string path, *softlist<string> content_types);
764 hash<RestExampleResponseInfo>
getExampleResponseImpl(
string method,
string path,
int code, *softlist<string> content_types);
1056 hash<string, AbstractParameterObject>
parameters();
1177 hash<string, AbstractParameterObject>
parameters();
1232 validateRequest(
bool serialize,
PathItemObject pio, reference<hash<UriQueryInfo>> h, reference<auto>
body, reference<hash> headers, *reference<hash<string, bool>> mime_types);
1299 getQoreExampleParams(reference<hash> query, reference<hash> headers, hash<string, AbstractParameterObject>
parameters, *hash<string, AbstractParameterObject> child_params);
1306 doDefaultParams(reference<hash<UriQueryInfo>> h, reference<hash> headers, reference<auto>
body, hash<string, AbstractParameterObject>
parameters, *hash<string, AbstractParameterObject> child_params);
1329 error(
string err,
string fmt);
1430 const OtherParameterMap = (
1451 abstract check(
bool serialize,
bool request,
string path,
string method,
string name, reference value);
1483 check(
bool serialize,
bool request,
string path,
string method,
string name, reference value);
1487 string getQoreExample(reference<hash<RestQoreExampleCodeInfo>> rv);
1491 auto getExampleValue();
1573 check(
bool serialize,
bool request,
string path,
string method,
string name, reference value);
1876 list<SchemaObject>
allOf();
1929 string getQoreExample(reference<hash<RestQoreExampleCodeInfo>> rv,
string name,
bool decl);
1933 auto getExampleValue();
1937 check(
bool serialize,
bool request,
string path,
string method,
string name, reference value);
1942 checkObjectProperty(
string name,
string prop);
1949 checkIntern(
bool serialize,
bool request,
string type, *
string format,
string path,
string method,
string name,
hash v, reference<hash> value);
2193 const SwaggerListToStringSet = -1;
2195 const SwaggerListToAnySet = -2;
2196 const SwaggerListToHashOfStrings = -3;
2206 SwaggerListToStringSet:
"list<string>",
2207 SwaggerListToAnySet:
"list<auto>",
2221 required_field(
string objType,
hash oh,
string name,
int typeCode, reference<auto> target);
2235 required_field(
string objType,
hash oh,
string name, hash<string, bool> typeCodes, reference<auto> target);
2250 bool optional_field(
string objType,
hash oh,
string name,
int typeCode, reference<auto> target);
2265 bool optional_field(
string objType,
hash oh,
string name, hash<string, bool> typeCodes, reference<auto> target);
2269 check_type_code(
string objType,
string name,
auto val,
int typeCode);
2273 get_value(
string objType,
string name,
int typeCode,
auto val, reference<auto> target);
2277 string get_qore_type(
string name,
string type, *
string format, *SchemaObject items);
hash< string, bool > produces
A set of MIME types (strings) the APIs can produce.
Definition: Swagger.qm.dox.h:487
Describes the operations available on a single path.
Definition: Swagger.qm.dox.h:1034
hash< string, SchemaObject > definitions()
An object to hold data types produced and consumed by operations.
Base used by OtherParameter, HeaderObject and SchemaObject.
Definition: Swagger.qm.dox.h:257
hash< string, ResponseObject > responses
Definition: Swagger.qm.dox.h:1608
ResponseObject defaultResp
Definition: Swagger.qm.dox.h:1601
check(bool serialize, bool request, string path, string method, string name, reference value)
validates the value against the schema definition
string pfx
path prefix
Definition: Swagger.qm.dox.h:946
hash< string, bool > consumes
A set of MIME types (strings) the APIs can consume.
Definition: Swagger.qm.dox.h:480
hash< RestQoreExampleCodeInfo > getQoreExampleRequest(string method, string path, PathItemObject pio, SwaggerSchema swagger)
returns example Qore code for the given request
This class stores the path tree for URI path matching.
Definition: Swagger.qm.dox.h:994
static ResponseObject newResponse(string key, hash oh, SwaggerSchema swagger)
returns a new ResponseObject corresponding to the schema definition passed
*PathItemObject pio
the PathItemObject associated with this path (if any)
Definition: Swagger.qm.dox.h:955
PathsObject paths
Required. The available paths and operations for the API.
Definition: Swagger.qm.dox.h:448
AbstractParameterObject resolveParameter(string name, string refstr, hash oh)
resolves a reference to a parameter
const ValidStringFormatsHash
A hash of valid string type formats.
Definition: Swagger.qm.dox.h:184
SchemaObject schema
Required. The schema defining the type used for the body parameter.
Definition: Swagger.qm.dox.h:1467
string name
Required. The name of the parameter. Parameter names are case sensitive.
Definition: Swagger.qm.dox.h:1407
static throwInvalidType(string name, string actual, string expected)
throws an SCHEMA-VALIDATION-ERROR exception
private
processes a client-side REST request and returns a hash that can be used to make the outgoing client-...
Definition: Swagger.qm.dox.h:789
Describes a single API operation on a path.
Definition: Swagger.qm.dox.h:1111
*ExternalDocumentationObject externalDocs
Additional external documentation.
Definition: Swagger.qm.dox.h:540
This is the root document object for the API specification. It combines what previously was the Resou...
Definition: Swagger.qm.dox.h:433
*int maxProperties
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.4.1.
Definition: Swagger.qm.dox.h:1811
string getQoreExample(reference< hash< RestQoreExampleCodeInfo >> rv)
generates Qore example code for a REST API call
string url
Required. The URL for the target documentation. Value MUST be in the format of a URL.
Definition: Swagger.qm.dox.h:1343
const ValidNumberFormatsHash
A hash of valid number type formats.
Definition: Swagger.qm.dox.h:182
string title
Required. The title of the application.
Definition: Swagger.qm.dox.h:854
*string prefix
The prefix to be used for the name.
Definition: Swagger.qm.dox.h:2067
*string name
The name of the header or query parameter to be used.
Definition: Swagger.qm.dox.h:2111
hash< string, PathComponent > paths
hash of non-wildcard paths to the next level
Definition: Swagger.qm.dox.h:958
checkMissingParams(hash< UriQueryInfo > h, *hash headers, auto body, hash< string, AbstractParameterObject > parameters, *hash< string, AbstractParameterObject > child_params)
checks for missing params
*PathComponent wildcard
if there is a wildcard to a PathComponent
Definition: Swagger.qm.dox.h:952
auto defaultVal
Declares the value of the parameter that the server will use if none is provided. ...
Definition: Swagger.qm.dox.h:1550
string name
Required. The name of the tag.
Definition: Swagger.qm.dox.h:1759
Holds the relative paths to the individual endpoints.
Definition: Swagger.qm.dox.h:941
static ParameterItemsSchemaObject newSchemaObject(string name, hash oh, SwaggerSchema swagger)
returns a SchemaObject for the schema definition; resolves references
*ExternalDocumentationObject externalDocs
Additional external documentation for this tag.
Definition: Swagger.qm.dox.h:1765
Allows the definition of a security scheme that can be used by the operations.
Definition: Swagger.qm.dox.h:2097
auto example
A free-form property to include an example of an instance for this schema.
Definition: Swagger.qm.dox.h:1892
*SchemaObject items
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.1.
Definition: Swagger.qm.dox.h:1805
bool allowEmptyValue
Sets the ability to pass empty-valued parameters.
Definition: Swagger.qm.dox.h:1521
main namespace for all public Swagger declarations
Definition: Swagger.qm.dox.h:158
ResponseObject resolveResponse(string name, string refstr, hash oh)
resolves a reference to a response
string name
current component name
Definition: Swagger.qm.dox.h:949
defines an object in a schema
Definition: Swagger.qm.dox.h:1781
const MimeDataTypes
supported mime types for de/serializing data
Definition: Swagger.qm.dox.h:187
AbstractParameterObject specialization for "body" parameters.
Definition: Swagger.qm.dox.h:1462
Lists the available scopes for an OAuth2 security scheme.
Definition: Swagger.qm.dox.h:2166
const ReferenceTypes
valid reference types
Definition: Swagger.qm.dox.h:1904
const MimeDataTypes const MimeContentTypes
MIME types for data serialization.
Definition: Swagger.qm.dox.h:214
check(bool serialize, bool request, string type, *string format, *SchemaObject items, string path, string method, string name, reference value)
validates the value against the schema definition
string method
the HTTP method for the operation
Definition: Swagger.qm.dox.h:1119
string mime_get_form_urlencoded_string(hash h)
*int minItems
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3.
Definition: Swagger.qm.dox.h:286
list< string > schemes
The transfer protocol for the operation.
Definition: Swagger.qm.dox.h:1190
*string termsOfService
The Terms of Service for the API.
Definition: Swagger.qm.dox.h:860
list< TagObject > tags
A list of tags used by the specification with additional metadata.
Definition: Swagger.qm.dox.h:537
A metadata object that allows for more fine-tuned XML model definitions.
Definition: Swagger.qm.dox.h:2049
const MimeTypeMultipartFormData
const ParameterCollectionFormats
valid parameter collection formats
Definition: Swagger.qm.dox.h:175
hash< string, bool > produces
A hash of MIME types (strings) the operation can produce.
Definition: Swagger.qm.dox.h:1166
*string inLoc
The location of the API key. Valid values are "query" or "header".
Definition: Swagger.qm.dox.h:2117
string path
the URI path for the operation
Definition: Swagger.qm.dox.h:1116
number number(softnumber n)
*ExternalDocumentationObject externalDocs
Additional external documentation for this schema.
Definition: Swagger.qm.dox.h:1889
check(bool serialize, bool request, string path, string method, string name, reference value)
verifies the parameter in an actual REST API call
const ValidSchemes
Valid transfer protocol schemes.
Definition: Swagger.qm.dox.h:217
static SchemaObject newSchemaObject(string name, hash oh, SwaggerSchema swagger)
returns a SchemaObject for the schema definition; resolves references
hash< string, softlist< string > > security
A declaration of which security schemes are applied for the API as a whole.
Definition: Swagger.qm.dox.h:525
initialize(hash oh)
Initialize.
hash< string, AbstractParameterObject > parameters()
A hash of parameters that are applicable for all the operations described under this path...
hash< string, bool > schemes
The transfer protocol of the API.
Definition: Swagger.qm.dox.h:473
hash< string, bool > required
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.4.3.
Definition: Swagger.qm.dox.h:1834
string name
Required. The license name used for the API.
Definition: Swagger.qm.dox.h:916
constructor()
Constructor.
*float multipleOf
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1.
Definition: Swagger.qm.dox.h:298
hash< RestQoreExampleCodeInfo > getQoreExampleResponse(string method, string path, int code)
returns example Qore code for the given response
static checkValueType(auto value, string type, *SchemaObject items, *string loc)
validates default values
*string host
The host (name or IP) serving the API.
Definition: Swagger.qm.dox.h:457
hash< RestSchemaValidator::RestExampleRequestInfo > getExampleRequest(string method, string path, PathItemObject pio, SwaggerSchema swagger, reference rbody)
returns a hash of example message information for the given request
*string def_path
the default path to use when retrieving external schema references
Definition: Swagger.qm.dox.h:556
validateRequest(bool serialize, PathItemObject pio, reference< hash< UriQueryInfo >> h, reference< auto > body, reference< hash > headers, *reference< hash< string, bool >> mime_types)
processes a REST API client-side request to the operation
auto defaultVal
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2.
Definition: Swagger.qm.dox.h:1808
checkIntern(bool serialize, bool request, string type, *string format, string path, string method, string name, hash v, reference< hash > value)
validates a schema object against a value
hash< string, bool > consumes
A list of MIME types (strings) the operation can consume.
Definition: Swagger.qm.dox.h:1158
list< SchemaObject > allOf()
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.3.
hash< string, list< string > > getPathOperationHash()
returns a hash of URI paths as keys with values as lists of supported HTTP methods ...
auto getDefaultValue()
returns the default value of the parameter (default: NOTHING)
*string desc
A brief description of the parameter. This could contain examples of use. GFM syntax can be used for ...
Definition: Swagger.qm.dox.h:1417
string name
the name of this object for documentation and example purposes
Definition: Swagger.qm.dox.h:1786
string swaggerSpec
Swagger Specification version being used.
Definition: Swagger.qm.dox.h:442
const MimeTypeFormUrlEncoded
*string desc
A short description for security scheme.
Definition: Swagger.qm.dox.h:2105
*ContactObject contact
The contact information for the exposed API.
Definition: Swagger.qm.dox.h:866
AbstractParameterObject body
the body parameter, if defined for this operation
Definition: Swagger.qm.dox.h:1180
error(string err, string fmt)
raises an exception with context information
Describes a single operation parameter.
Definition: Swagger.qm.dox.h:1395
parseRequest(PathItemObject pio, reference< hash< UriQueryInfo >> h, reference< auto > body, reference< hash > headers)
parses and processes a REST request on the server side
*int maxItems
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2.
Definition: Swagger.qm.dox.h:283
License information for the exposed API.
Definition: Swagger.qm.dox.h:911
const ValidStringFormats
Valid string type formats.
Definition: Swagger.qm.dox.h:164
*bool exclusiveMin
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3.
Definition: Swagger.qm.dox.h:271
*string desc
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.1.
Definition: Swagger.qm.dox.h:1802
string type
Required. The type of the security scheme. Valid values are "basic", "apiKey" or "oauth2".
Definition: Swagger.qm.dox.h:2102
string version
Required. Provides the version of the application API (not to be confused with the specification vers...
Definition: Swagger.qm.dox.h:863
*ScopesObject scopes
The available scopes for the OAuth2 security scheme.
Definition: Swagger.qm.dox.h:2147
const ParameterTypes
valid parameter types
Definition: Swagger.qm.dox.h:1553
*int maxLength
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1.
Definition: Swagger.qm.dox.h:274
*string desc
A short description of the target documentation. GFM syntax can be used for rich text representation...
Definition: Swagger.qm.dox.h:1340
OperationObject getOperation(string method, string path)
returns the operation object for the given method
hash getExternalReference(string refstr)
retrieves external references
string type
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.2.
Definition: Swagger.qm.dox.h:1793
add(string full_path, list l, int offset, hash oh, SwaggerSchema swagger)
adds a component or a Path Item Object to the tree
string getBasePathImpl()
returns the base path prefix for all requests in this schema
const CollectionFormats
allowed collection formats
Definition: Swagger.qm.dox.h:167
*string format
The extending format for the previously mentioned type. See Data Type Formats for further details...
Definition: Swagger.qm.dox.h:1513
auto getExampleValue()
returns an example value of the parameter (default: NOTHING)
static hash parseSchemaContent(string filepath, string str)
Load a schema definition from a file.
hash< RestQoreExampleCodeInfo > getQoreExampleResponseImpl(string method, string path, int code)
returns example Qore code for the given response
AbstractParameterObject specialization for parameters other than "body".
Definition: Swagger.qm.dox.h:1496
doDefaultParams(reference< hash< UriQueryInfo >> h, reference< hash > headers, reference< auto > body, hash< string, AbstractParameterObject > parameters, *hash< string, AbstractParameterObject > child_params)
add default parameters
static checkValueType(auto value, string type, *SchemaObject items, *string loc)
validates default values
Base class for the Swagger specification objects, wrapping the vendor extensions. ...
Definition: Swagger.qm.dox.h:221
hash< string, SecuritySchemeObject > securityDefinitions
Security scheme definitions that can be used across the specification.
Definition: Swagger.qm.dox.h:511
PathComponent paths
the tree of path components for path matching with wildcards
Definition: Swagger.qm.dox.h:999
bool readOnly
Relevant only for Schema "properties" definitions. Declares the property as "read only"...
Definition: Swagger.qm.dox.h:1865
*string format
The extending format for the previously mentioned type. See Data Type Formats for further details...
Definition: Swagger.qm.dox.h:1796
list tags
A list of tags (strings or TagObjects) for API documentation control.
Definition: Swagger.qm.dox.h:1125
hash< RestSchemaValidator::RestResponseClientInfo > parseResponseImpl(string method, string path, int code, *data response_body, hash hdr)
parses and validates the response from the server and returns a hash of the processed info ...
const ValidNumberFormats
Valid number type formats.
Definition: Swagger.qm.dox.h:162
*ParameterItemsSchemaObject items
Required if type is "array". Describes the type of items in the array.
Definition: Swagger.qm.dox.h:1524
const ScalarTypes
valid scalar types
Definition: Swagger.qm.dox.h:1895
SchemaObject resolveSchemaObject(string name, string refstr, hash oh)
resolves a reference to a schema object
*string name
Replaces the name of the element/attribute used for the described schema property.
Definition: Swagger.qm.dox.h:2061
hash< RestSchemaValidator::RestRequestClientInfo > processRequestImpl(string method, string path, auto body, *hash headers, *softlist< string > content_types)
processes a client-side REST request and returns a hash that can be used to make the outgoing client-...
hash< string, ResponseObject > responses
Response definitions that can be used across operations. This property does not define global respons...
Definition: Swagger.qm.dox.h:505
AbstractParameterObject body
The body parameter, if defined for this path.
Definition: Swagger.qm.dox.h:1059
hash< string, SchemaObject > properties
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.4.4.
Definition: Swagger.qm.dox.h:1821
string desc
Required. A short description of the response. GFM syntax can be used for rich text representation...
Definition: Swagger.qm.dox.h:1633
bool wrapped
MAY be used only for an array definition. Signifies whether the array is wrapped (for example...
Definition: Swagger.qm.dox.h:2077
InfoObject info
Required. Provides metadata about the API. The metadata can be used by the clients if needed...
Definition: Swagger.qm.dox.h:445
hash< string, OperationObject > operations
A hash of OperationObjects correspoding to different methods.
Definition: Swagger.qm.dox.h:1075
*string basePath
The base path on which the API is served, which is relative to the host.
Definition: Swagger.qm.dox.h:465
hash< RestSchemaValidator::RestRequestServerInfo > parseRequestImpl(string method, string path, *data http_body, reference< hash > headers)
processes and parses a client request and returns the deserialized message body (if any) ...
checkArrayParam(bool serialize, bool request, SchemaObject items, string path, string method, string name, reference< softlist > value)
validates the value against the schema definition
constructor(hash oh, string pfx, SwaggerSchema swagger)
creates the object
static SwaggerSchema fromFile(string filepath)
Load Swagger definition from a file.
hash< RestExampleResponseInfo > getExampleResponseImpl(string method, string path, int code, *softlist< string > content_types)
returns a hash of example message information for the given request
hash< HttpResponseInfo > processResponseImpl(string method, string path, int code, auto response_body, *hash headers, *softlist< string > content_types)
processes a REST response with a serialized message body, validates any response data against schema ...
auto getDefaultValue()
returns the default value of the parameter (default: NOTHING)
bool required
Determines whether this parameter is mandatory.
Definition: Swagger.qm.dox.h:1425
*float minimum
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3.
Definition: Swagger.qm.dox.h:265
*int minProperties
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.4.2.
Definition: Swagger.qm.dox.h:1814
*bool uniqueItems
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4.
Definition: Swagger.qm.dox.h:289
hash< string, AbstractParameterObject > parameters()
A hash of parameters that are applicable for this operation.
*string flow
The flow used by the OAuth2 security scheme.
Definition: Swagger.qm.dox.h:2125
setBasePathImpl(string basePath)
overrides the basePath value
ParameterItemsSchemaObject resolveParameterItemsSchemaObject(string name, string refstr, hash oh)
resolves a reference to a parameter items schema object
Allows referencing an external resource for extended documentation.
Definition: Swagger.qm.dox.h:1335
*string operationId
Unique string used to identify the operation.
Definition: Swagger.qm.dox.h:1150
validateResponse(string method, string path, PathItemObject pio, int code, reference< auto > response_body, reference< hash< string, bool >> mime_types)
validates a response against the response definition, if any
softlist getMethods()
returns a list of HTTP methods supported by this object
auto additionalProperties
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.4.4.
Definition: Swagger.qm.dox.h:1828
*string url
A URL to the license used for the API. MUST be in the format of a URL.
Definition: Swagger.qm.dox.h:919
string string(softstring str, *string enc)
*string ref
Allows for an external definition of this path item.
Definition: Swagger.qm.dox.h:1044
*string ns
The URL of the namespace definition. Value SHOULD be in the form of a URL.
Definition: Swagger.qm.dox.h:2064
*bool exclusiveMax
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2.
Definition: Swagger.qm.dox.h:268
*float maximum
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2.
Definition: Swagger.qm.dox.h:262
bool attribute
Declares whether the property definition translates to an attribute instead of an element...
Definition: Swagger.qm.dox.h:2070
Definition: Swagger.qm.dox.h:2191
const ValidIntFormatsHash
A hash of valid integer type formats.
Definition: Swagger.qm.dox.h:180
getPathOperationHash(reference< hash< string, list< string >>> h)
returns a hash of URI paths as keys with values as lists of supported HTTP methods ...
ResponsesObject responses
Required. The list of possible responses as they are returned from executing this operation...
Definition: Swagger.qm.dox.h:1183
*string tokenUrl
The token URL to be used for this flow. This SHOULD be in the form of a URL.
Definition: Swagger.qm.dox.h:2137
*string desc
A short description of the application. GFM syntax can be used for rich text representation.
Definition: Swagger.qm.dox.h:857
hash< string, AbstractParameterObject > parameters()
Parameter definitions that can be used across operations. This property does not define global parame...
*string authorizationUrl
The authorization URL to be used for this flow. This SHOULD be in the form of a URL.
Definition: Swagger.qm.dox.h:2131
static AbstractParameterObject newParameter(string name, hash oh, SwaggerSchema swagger)
gets a concrete instance of an AbstractParameterObject
hash< RestExampleResponseInfo > getExampleResponse(string method, string path, int code, reference body)
returns a hash of example message information for the given request
string getTargetUrlImpl()
returns the target URL for the schema
string inLoc
Required. The location of the parameter.
Definition: Swagger.qm.dox.h:1414
const ValidIntFormats
Valid integer type formats.
Definition: Swagger.qm.dox.h:160
bool compact_serialization
if serialized data should be subject to compact serialization (default: True)
Definition: Swagger.qm.dox.h:553
*SchemaObject schema
A definition of the response structure.
Definition: Swagger.qm.dox.h:1642
*string desc
A short description for the tag. GFM syntax can be used for rich text representation.
Definition: Swagger.qm.dox.h:1762
*ExternalDocumentationObject externalDocs
Additional external documentation for this operation.
Definition: Swagger.qm.dox.h:1141
abstract check(bool serialize, bool request, string path, string method, string name, reference value)
verifies the parameter in an actual REST API call
const SwaggerOptions
SwaggerSchema options.
Definition: Swagger.qm.dox.h:543
*code try_import
a call reference or closure to be passed a string name for external schema references, must take a string argument (the resource name) and return a string (the resource data)
Definition: Swagger.qm.dox.h:559
list< hash< string, list< string > > > security
A declaration of which security schemes are applied for this operation.
Definition: Swagger.qm.dox.h:1205
items schema object for non-body parameters
Definition: Swagger.qm.dox.h:1981
contains the possible responses for an operation
Definition: Swagger.qm.dox.h:1593
hash vendorExtensions
Allows extensions to the Swagger Schema.
Definition: Swagger.qm.dox.h:230
constructor(string objType, hash oh)
Constructor.
*string collectionFormat
Determines the format of the array if type array is used.
Definition: Swagger.qm.dox.h:1999
hash< string, list< string > > getPathOperationHashImpl()
returns a hash of URI paths as keys with values as lists of supported HTTP methods ...
const SerializationModules
modules available for data serialization and/or deserialization
Definition: Swagger.qm.dox.h:211
PathItemObject match(string path)
matches a URI path with a PathItemObject
hash< RestSchemaValidator::RestExampleRequestInfo > getExampleRequestImpl(string method, string path, *softlist< string > content_types)
returns a hash of example message information for the given request
auto getExampleValue(string type, *string format)
returns an example value for the given type
*string title
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.1.
Definition: Swagger.qm.dox.h:1799
*string pattern
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
Definition: Swagger.qm.dox.h:280
string getQoreExample(reference< hash< RestQoreExampleCodeInfo >> rv, string name, bool decl)
returns example Qore code for the object
The object provides metadata about the API. The metadata can be used by the clients if needed...
Definition: Swagger.qm.dox.h:849
*string collectionFormat
Determines the format of the array if type array is used.
Definition: Swagger.qm.dox.h:1540
hash headers
A hash of headers that are (can be) sent with the response.
Definition: Swagger.qm.dox.h:1648
Used for loading the Swagger definitions.
Definition: Swagger.qm.dox.h:395
hash examples
A hash of example response messages.
Definition: Swagger.qm.dox.h:1658
hash< string, string > fields
Maps between a name of a scope to a short description of it (as the value of the property).
Definition: Swagger.qm.dox.h:2174
*ResponseObject getResponse(int code)
returns the ResponseObject for hthe given HTTP code or NOTHING if none is configured ...
*string discriminator
Adds support for polymorphism.
Definition: Swagger.qm.dox.h:1855
string type
Required. The type of the parameter.
Definition: Swagger.qm.dox.h:1510
hash< auto > mime_parse_form_urlencoded_string(string str)
Describes a single response from an API Operation.
Definition: Swagger.qm.dox.h:1628
PathItemObject match(list path)
returns either a PathItemObject for the path
Allows adding metadata to a single tag that is used by the OperationObject. It is not mandatory to ha...
Definition: Swagger.qm.dox.h:1754
*XmlObject xml
This MAY be used only on properties schemas. It has no effect on root schemas.
Definition: Swagger.qm.dox.h:1886
static SwaggerSchema fromString(string swaggerSpecification, bool json=True)
Load Swagger definition from a string.
*string desc
A verbose explanation of the operation behavior. GFM syntax can be used for rich text representation...
Definition: Swagger.qm.dox.h:1131
check(bool serialize, bool request, string path, string method, string name, reference value)
validates the value against the schema definition
bool deprec
Declares this operation to be deprecated.
Definition: Swagger.qm.dox.h:1138
*string summary
A short summary of what the operation does.
Definition: Swagger.qm.dox.h:1128
*LicenseObject license
The license information for the exposed API.
Definition: Swagger.qm.dox.h:869
*int minLength
See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2.
Definition: Swagger.qm.dox.h:277
hash< RestQoreExampleCodeInfo > getQoreExampleRequestImpl(string method, string path)
returns example Qore code for the given request