Qore SwaggerDataProvider Module Reference 1.3
Loading...
Searching...
No Matches
SwaggerRequestDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
26namespace SwaggerDataProvider {
29
30public:
32 string uri_path;
33
36
38 PathItemObject pio;
39
41 OperationObject op;
42
45
47 *hash<string, AbstractDataField> record_type;
48
50 constructor(SwaggerSchema schema, *RestClient rest, string uri_path, PathItemObject pio, OperationObject op) ;
51
52
54 string getName();
55
56
58 *string getDesc();
59
60
62 hash<DataProviderInfo> getInfo();
63
64
66
68protected:
69 *hash<string, AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
70public:
71
72
73protected:
74 *hash<string, AbstractDataField> getRecordTypeIntern();
75public:
76
77
79protected:
80 *AbstractDataProviderType getRequestTypeImpl();
81public:
82
83
85protected:
86 *AbstractDataProviderType getResponseTypeImpl();
87public:
88
89
91protected:
92 *hash<string, AbstractDataProviderType> getErrorResponseTypesImpl();
93public:
94
95
97
103protected:
104 AbstractDataProviderType getErrorResponseTypeImpl(string error_code);
105public:
106
107
109protected:
110 AbstractDataProviderType getResponseTypeIntern(ResponseObject response, string label);
111public:
112
113
115protected:
116 *ResponseObject getSuccessResponse();
117public:
118
119
121
126protected:
127 auto doRequestImpl(auto req, *hash<auto> request_options);
128public:
129
130
132
140protected:
141 AbstractDataProviderRecordIterator requestSearchRecordsImpl(auto req, *hash<DataProviderExpression> where_cond, *hash<auto> search_options);
142public:
143
144
146
154protected:
155 AbstractDataProviderRecordIterator requestSearchRecordsImpl(auto req, *hash<auto> where_cond, *hash<auto> search_options);
156public:
157
158
160protected:
161 hash<auto> doRequestIntern(auto req, *hash<auto> options);
162public:
163
164
166 string getUriValue(auto v);
167
168
170protected:
171 string getUriPath();
172public:
173
174
176protected:
178public:
179
180
182protected:
183 hash<DataProviderInfo> getStaticInfoImpl();
184public:
185
186};
187};
The Swagger data provider base class.
Definition: SwaggerDataProviderBase.qc.dox.h:28
SwaggerSchema schema
The Swagger schema.
Definition: SwaggerDataProviderCommon.qc.dox.h:33
*RestClient::RestClient rest
The REST client object for API calls.
Definition: SwaggerDataProviderCommon.qc.dox.h:36
The Swagger data provider class.
Definition: SwaggerRequestDataProvider.qc.dox.h:28
AbstractDataProviderType getErrorResponseTypeImpl(string error_code)
Returns the type for the given error code.
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returned the response.
AbstractDataProviderRecordIterator requestSearchRecordsImpl(auto req, *hash< auto > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
AbstractDataProviderType getResponseTypeIntern(ResponseObject response, string label)
Returns a data provider type object for a Swagger response.
string uri_path
The current URI path.
Definition: SwaggerRequestDataProvider.qc.dox.h:32
PathItemObject pio
The path item object for the operation.
Definition: SwaggerRequestDataProvider.qc.dox.h:38
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
string getUriPath()
Returns the URI path to use in requests.
*AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
hash< auto > doRequestIntern(auto req, *hash< auto > options)
Makes a REST request and returns the response.
OperationObject op
The operation object.
Definition: SwaggerRequestDataProvider.qc.dox.h:41
*hash< string, AbstractDataField > getRecordTypeImpl(*hash< auto > search_options)
Returns the description of the record type, if any.
*hash< string, AbstractDataProviderType > getErrorResponseTypesImpl()
Returns a hash of error responses, if any.
*string getDesc()
Returns the data provider description.
string getName()
Returns the data provider name.
constructor(SwaggerSchema schema, *RestClient rest, string uri_path, PathItemObject pio, OperationObject op)
Creates the object from the arguments.
AbstractDataProviderRecordIterator requestSearchRecordsImpl(auto req, *hash< DataProviderExpression > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
*AbstractDataProviderType getResponseTypeImpl()
Returns the description of a successful response message, if any.
string success_response
The success response code, if any.
Definition: SwaggerRequestDataProvider.qc.dox.h:44
hash< DataProviderInfo > getInfo()
Returns data provider info.
RestClient getRestClient()
Returns a REST client for HTTP operations.
*ResponseObject getSuccessResponse()
Returns the schema for the first successful response message found.
*hash< string, AbstractDataField > record_type
If the request supports a list of hashes in the response and therefore the record API.
Definition: SwaggerRequestDataProvider.qc.dox.h:47
string getUriValue(auto v)
Returns the value for the given query argument.
bool resolve_uri
The URI needs dynamic resolution.
Definition: SwaggerRequestDataProvider.qc.dox.h:35
Qore SwaggerDataProvider module definition.
Definition: SwaggerDataProvider.qc.dox.h:26