SwaggerDataProvider.qc.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
namespace SwaggerDataProvider {
class SwaggerDataProvider : public SwaggerDataProviderCommon {
 
public:
        string uri_path = "/";
 
        string display_name;
 
        const ProviderInfo = <DataProviderInfo>{
            "type": "SwaggerDataProvider",
            "supports_read": False,
            "supports_create": False,
            "supports_update": False,
            "supports_upsert": False,
            "supports_delete": False,
            "supports_native_search": False,
            "supports_bulk_create": False,
            "supports_bulk_upsert": False,
            "supports_children": True,
            "constructor_options": ConstructorOptions,
            "search_options": NOTHING,
            "create_options": NOTHING,
            "upsert_options": NOTHING,
            "transaction_management": False,
            "supports_schema": True,
            "schema_type": "swagger",
            "children_can_support_apis": True,
            "children_can_support_records": False,
            "children_can_support_observers": False,
        };
 
        const ConstructorOptions = {
            "lax_parsing": <DataProviderOptionInfo>{
                "type": AbstractDataProviderTypeMap."bool",
                "desc": "If `True` then common errors in Swagger schemas will be ignored; some Swagger schemas with "
                    "errors will be able to be used",
            },
            "restclient": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(new Type("RestClient"), NOTHING, {
                    DTT_ClientOnly: True,
                }),
                "desc": "the RestClient object",
            },
            "restclient_options": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(AutoHashType, NOTHING, {
                    DTT_ClientOnly: True,
                }),
                "desc": "options to the RestClient constructor; only used if a RestClient object is created for a "
                    "call",
            },
            "schema": <DataProviderOptionInfo>{
                "type": (
                    AbstractDataProviderType::get(StringType, NOTHING, {
                        DTT_FromFile: True,
                        DTT_FromLocation: True,
                    }),
                    AbstractDataProviderType::get(new Type("SwaggerSchema")),
                ),
                "desc": "the Swagger schema object or source URL",
                "required": True,
            },
            "url": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(StringType, NOTHING, {
                    DTT_ClientOnly: True,
                }),
                "desc": "the URL to the REST server; overrides any URL in the schema or in any RestClient object "
                    "passed as an option",
            },
        };
 
        const HttpMethods = {
            "GET": True,
            "PUT": True,
            "PATCH": True,
            "POST": True,
            "DELETE": True,
        };
 
protected:
        hash<auto> path_tree;
 
public:
 
protected:
     constructor(hash<auto> path_tree, string uri_path, SwaggerSchema schema, *RestClient rest) ;
public:
 
 
    constructor(SwaggerSchema schema, *RestClient rest) ;
 
 
    constructor(*hash<auto> options);
 
 
    string getName();
 
 
    *string getDesc();
 
 
protected:
     setSchema(SwaggerSchema schema);
public:
 
 
protected:
     checkRestClient(RestClient rest);
public:
 
 
protected:
     setupTree();
public:
 
 
 
protected:
     *list<string> getChildProviderNamesImpl();
public:
 
 
 
protected:
     *AbstractDataProvider getChildProviderImpl(string name);
public:
 
 
protected:
     AbstractDataProvider getChildIntern(string name, *string real_name);
public:
 
 
protected:
     hash<DataProviderInfo> getStaticInfoImpl();
public:
 
 
protected:
     object getSchemaObjectImpl();
public:
 
};
}; // end namespace swagger