$darkmode
Qore SwaggerDataProvider Module Reference 1.3
SwaggerRequestDataProvider.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
26 namespace SwaggerDataProvider {
29 
30 public:
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 
68 protected:
69  *hash<string, AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
70 public:
71 
72 
73 protected:
74  *hash<string, AbstractDataField> getRecordTypeIntern();
75 public:
76 
77 
79 protected:
80  *AbstractDataProviderType getRequestTypeImpl();
81 public:
82 
83 
85 protected:
86  *AbstractDataProviderType getResponseTypeImpl();
87 public:
88 
89 
91 protected:
92  *hash<string, AbstractDataProviderType> getErrorResponseTypesImpl();
93 public:
94 
95 
97 
103 protected:
104  AbstractDataProviderType getErrorResponseTypeImpl(string error_code);
105 public:
106 
107 
109 protected:
110  AbstractDataProviderType getResponseTypeIntern(ResponseObject response, string label);
111 public:
112 
113 
115 protected:
116  *ResponseObject getSuccessResponse();
117 public:
118 
119 
121 
126 protected:
127  auto doRequestImpl(auto req, *hash<auto> request_options);
128 public:
129 
130 
132 
140 protected:
141  AbstractDataProviderRecordIterator requestSearchRecordsImpl(auto req, *hash<DataProviderExpression> where_cond, *hash<auto> search_options);
142 public:
143 
144 
146 
154 protected:
155  AbstractDataProviderRecordIterator requestSearchRecordsImpl(auto req, *hash<auto> where_cond, *hash<auto> search_options);
156 public:
157 
158 
160 protected:
161  hash<auto> doRequestIntern(auto req, *hash<auto> options);
162 public:
163 
164 
166  string getUriValue(auto v);
167 
168 
170 protected:
171  string getUriPath();
172 public:
173 
174 
176 protected:
178 public:
179 
180 
182 protected:
183  hash<DataProviderInfo> getStaticInfoImpl();
184 public:
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.
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
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
string getUriPath()
Returns the URI path to use in requests.
*AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
hash< DataProviderInfo > getInfo()
Returns data provider info.
OperationObject op
The operation object.
Definition: SwaggerRequestDataProvider.qc.dox.h:41
*string getDesc()
Returns the data provider description.
*hash< string, AbstractDataProviderType > getErrorResponseTypesImpl()
Returns a hash of error responses, if any.
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
RestClient getRestClient()
Returns a REST client for HTTP operations.
*hash< string, AbstractDataField > getRecordTypeImpl(*hash< auto > search_options)
Returns the description of the record type, if any.
*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
hash< auto > doRequestIntern(auto req, *hash< auto > options)
Makes a REST request and returns the response.
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