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
44 AbstractDataProviderType request_type;
45
47 AbstractDataProviderType response_type;
48
51
53 *list<string> response_headers;
54
56 *hash<string, AbstractDataField> record_type;
57
58protected:
61
62public:
63
65 constructor(SwaggerSchema schema, *RestClient rest, string uri_path, PathItemObject pio, OperationObject op) ;
66
67
69 string getName();
70
71
73 *string getDesc();
74
75
77 hash<DataProviderInfo> getInfo();
78
79
82
83
85
93 auto doRequest(auto req, *hash<auto> request_options);
94
95
97
99protected:
100 *hash<string, AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
101public:
102
103
104protected:
105 *hash<string, AbstractDataField> getRecordTypeIntern();
106public:
107
108
110protected:
111 *AbstractDataProviderType getRequestTypeImpl();
112public:
113
114
116protected:
117 *AbstractDataProviderType getResponseTypeImpl();
118public:
119
120
122protected:
123 *hash<string, AbstractDataProviderType> getErrorResponseTypesImpl();
124public:
125
126
128
134protected:
135 AbstractDataProviderType getErrorResponseTypeImpl(string error_code);
136public:
137
138
140protected:
141 AbstractDataProviderType getResponseTypeIntern(ResponseObject response, string label);
142public:
143
144
146protected:
147 *ResponseObject getSuccessResponse();
148public:
149
150
152
157protected:
158 auto doRequestImpl(auto req, *hash<auto> request_options);
159public:
160
161
163
171protected:
172 AbstractDataProviderRecordIterator requestSearchRecordsImpl(auto req, *hash<DataProviderExpression> where_cond, *hash<auto> search_options);
173public:
174
175
177
185protected:
186 AbstractDataProviderRecordIterator requestSearchRecordsImpl(auto req, *hash<auto> where_cond, *hash<auto> search_options);
187public:
188
189
191protected:
192 *hash<auto> doRequestIntern(auto req, *hash<auto> options);
193public:
194
195
197 string getUriValue(auto v);
198
199
201protected:
202 string getUriPath();
203public:
204
205
207protected:
209public:
210
211
213protected:
214 hash<DataProviderInfo> getStaticInfoImpl();
215public:
216
217};
218};
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.
*hash< auto > doRequestIntern(auto req, *hash< auto > options)
Makes a REST request and returns 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.
auto doRequest(auto req, *hash< auto > request_options)
Makes a request and returns the response.
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
AbstractDataProviderType request_type
The request type.
Definition SwaggerRequestDataProvider.qc.dox.h:44
*list< string > response_headers
Any headers to return in the response.
Definition SwaggerRequestDataProvider.qc.dox.h:53
PathItemObject pio
The path item object for the operation.
Definition SwaggerRequestDataProvider.qc.dox.h:38
AbstractDataProviderType response_type
The response type.
Definition SwaggerRequestDataProvider.qc.dox.h:47
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.
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.
disableRequestTypeCheck()
Disable the request type check.
*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:50
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:56
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
bool disable_request_type_check
Disable checking the request type.
Definition SwaggerRequestDataProvider.qc.dox.h:60
Qore SwaggerDataProvider module definition.
Definition SwaggerDataProvider.qc.dox.h:26