@itentialopensource/adapter-gitlab 0.7.2 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/AUTH.md +39 -0
  2. package/BROKER.md +199 -0
  3. package/CALLS.md +169 -0
  4. package/CHANGELOG.md +60 -25
  5. package/CODE_OF_CONDUCT.md +12 -17
  6. package/CONTRIBUTING.md +88 -74
  7. package/ENHANCE.md +69 -0
  8. package/PROPERTIES.md +641 -0
  9. package/README.md +221 -571
  10. package/SUMMARY.md +9 -0
  11. package/SYSTEMINFO.md +11 -0
  12. package/TROUBLESHOOT.md +47 -0
  13. package/adapter.js +357 -60
  14. package/adapterBase.js +1021 -245
  15. package/entities/.generic/action.json +110 -5
  16. package/entities/.generic/schema.json +6 -1
  17. package/entities/BroadcastMessage/action.json +5 -5
  18. package/error.json +6 -0
  19. package/package.json +13 -7
  20. package/pronghorn.json +652 -378
  21. package/propertiesDecorators.json +14 -0
  22. package/propertiesSchema.json +421 -0
  23. package/refs?service=git-upload-pack +0 -0
  24. package/report/adapterInfo.json +10 -0
  25. package/report/updateReport1652962168533.json +120 -0
  26. package/sampleProperties.json +90 -1
  27. package/test/integration/adapterTestBasicGet.js +1 -1
  28. package/test/integration/adapterTestIntegration.js +26 -102
  29. package/test/unit/adapterBaseTestUnit.js +30 -25
  30. package/test/unit/adapterTestUnit.js +209 -180
  31. package/utils/adapterInfo.js +206 -0
  32. package/utils/addAuth.js +94 -0
  33. package/utils/basicGet.js +1 -14
  34. package/utils/entitiesToDB.js +179 -0
  35. package/utils/modify.js +1 -1
  36. package/utils/patches2bundledDeps.js +90 -0
  37. package/utils/pre-commit.sh +3 -0
  38. package/utils/removeHooks.js +20 -0
  39. package/utils/tbScript.js +43 -22
  40. package/utils/tbUtils.js +126 -29
  41. package/utils/testRunner.js +16 -16
  42. package/utils/troubleshootingAdapter.js +2 -26
package/pronghorn.json CHANGED
@@ -9,384 +9,648 @@
9
9
  "admin"
10
10
  ],
11
11
  "methods": [
12
- {
13
- "name": "updateAdapterConfiguration",
14
- "summary": "Updates the adapter configuration",
15
- "description": "Updates the adapter configuration file with the provided changes",
16
- "input": [
17
- {
18
- "name": "configFile",
19
- "type": "string",
20
- "info": "The name of the file to change",
21
- "required": true,
22
- "schema": {
23
- "title": "configFile",
24
- "type": "string"
25
- }
26
- },
27
- {
28
- "name": "changes",
29
- "type": "object",
30
- "info": "JSON object containing the configuration changes",
31
- "required": true,
32
- "schema": {
33
- "title": "changes",
34
- "type": "object"
35
- }
36
- },
37
- {
38
- "name": "entity",
39
- "type": "string",
40
- "info": "The entity in which the changes are being made",
41
- "required": false,
42
- "schema": {
43
- "title": "entity",
44
- "type": "string"
45
- }
46
- },
47
- {
48
- "name": "type",
49
- "type": "string",
50
- "info": "The type of file to change - action, schema, or mock",
51
- "required": false,
52
- "schema": {
53
- "title": "type",
54
- "type": "string"
55
- }
56
- },
57
- {
58
- "name": "action",
59
- "type": "string",
60
- "info": "The action to be changed",
61
- "required": false,
62
- "schema": {
63
- "title": "action",
64
- "type": "string"
65
- }
66
- }
67
- ],
68
- "output": {
69
- "name": "result",
70
- "type": "object",
71
- "description": "A JSON Object containing status, code and the result",
72
- "schema": {
73
- "title": "result",
74
- "type": "object"
75
- }
76
- },
77
- "roles": [
78
- "admin"
79
- ],
80
- "route": {
81
- "verb": "POST",
82
- "path": "/updateAdapterConfiguration"
83
- },
84
- "task": true
85
- },
86
- {
87
- "name": "findPath",
88
- "summary": "Provides the ability to see if a particular API path is supported by the adapter",
89
- "description": "Provides the ability to see if a particular API path is supported by the adapter",
90
- "input": [
91
- {
92
- "name": "apiPath",
93
- "type": "string",
94
- "info": "The API Path you want to check - make sure to not include base path and version",
95
- "description": "The API Path you want to check - make sure to not include base path and version",
96
- "schema": {
97
- "title": "apiPath",
98
- "type": "string"
99
- },
100
- "required": true
101
- }
102
- ],
103
- "output": {
104
- "name": "result",
105
- "type": "object",
106
- "description": "A JSON Object containing the result",
107
- "schema": {
108
- "title": "result",
109
- "type": "object"
110
- }
111
- },
112
- "roles": [
113
- "admin"
114
- ],
115
- "route": {
116
- "verb": "POST",
117
- "path": "/findPath"
118
- },
119
- "task": true
120
- },
121
- {
122
- "name": "troubleshoot",
123
- "summary": "Runs troubleshoot script for adapter",
124
- "description": "Runs troubleshoot script for adapter",
125
- "input": [
126
- {
127
- "name": "props",
128
- "type": "object",
129
- "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
130
- "required": true,
131
- "schema": {
132
- "title": "props",
133
- "type": "object"
134
- }
135
- },
136
- {
137
- "name": "persistFlag",
138
- "type": "boolean",
139
- "info": "Whether the input properties should be saved",
140
- "required": true
141
- }
142
- ],
143
- "output": {
144
- "name": "result",
145
- "type": "object",
146
- "description": "A JSON Object containing the test results",
147
- "schema": {
148
- "title": "result",
149
- "type": "object"
150
- }
151
- },
152
- "roles": [
153
- "admin"
154
- ],
155
- "route": {
156
- "verb": "POST",
157
- "path": "/troubleshoot"
158
- },
159
- "task": true
160
- },
161
- {
162
- "name": "runHealthcheck",
163
- "summary": "Runs healthcheck script for adapter",
164
- "description": "Runs healthcheck script for adapter",
165
- "input": [],
166
- "output": {
167
- "name": "result",
168
- "type": "boolean",
169
- "description": "Whether healthcheck passed or failed"
170
- },
171
- "roles": [
172
- "admin"
173
- ],
174
- "route": {
175
- "verb": "POST",
176
- "path": "/runHealthcheck"
177
- },
178
- "task": true
179
- },
180
- {
181
- "name": "runConnectivity",
182
- "summary": "Runs connectivity check script for adapter",
183
- "description": "Runs connectivity check script for adapter",
184
- "input": [],
185
- "output": {
186
- "name": "result",
187
- "type": "object",
188
- "description": "A JSON Object containing the test results",
189
- "schema": {
190
- "title": "result",
191
- "type": "object"
192
- }
193
- },
194
- "roles": [
195
- "admin"
196
- ],
197
- "route": {
198
- "verb": "POST",
199
- "path": "/runConnectivity"
200
- },
201
- "task": true
202
- },
203
- {
204
- "name": "runBasicGet",
205
- "summary": "Runs basicGet script for adapter",
206
- "description": "Runs basicGet script for adapter",
207
- "input": [],
208
- "output": {
209
- "name": "result",
210
- "type": "object",
211
- "description": "A JSON Object containing the test results",
212
- "schema": {
213
- "title": "result",
214
- "type": "object"
215
- }
216
- },
217
- "roles": [
218
- "admin"
219
- ],
220
- "route": {
221
- "verb": "POST",
222
- "path": "/runBasicGet"
223
- },
224
- "task": true
225
- },
226
- {
227
- "name": "suspend",
228
- "summary": "Suspends the adapter",
229
- "description": "Suspends the adapter",
230
- "input": [
231
- {
232
- "name": "mode",
233
- "type": "enum",
234
- "enumerals": [
235
- "pause",
236
- "error"
237
- ],
238
- "info": "How incoming requests are handled. Defaults to 'pause'",
239
- "description": "How incoming requests are handled. Defaults to 'pause'",
240
- "schema": {
241
- "title": "mode",
242
- "type": "string"
243
- },
244
- "required": false
245
- }
246
- ],
247
- "output": {
248
- "name": "result",
249
- "type": "object",
250
- "description": "A JSON Object containing the adapter suspended status",
251
- "schema": {
252
- "title": "result",
253
- "type": "object"
254
- }
255
- },
256
- "roles": [
257
- "admin"
258
- ],
259
- "route": {
260
- "verb": "POST",
261
- "path": "/suspend"
262
- },
263
- "task": true
264
- },
265
- {
266
- "name": "unsuspend",
267
- "summary": "Unsuspends the adapter",
268
- "description": "Unsuspends the adapter",
269
- "input": [],
270
- "output": {
271
- "name": "result",
272
- "type": "object",
273
- "description": "A JSON Object containing the adapter suspended status",
274
- "schema": {
275
- "title": "result",
276
- "type": "object"
277
- }
278
- },
279
- "roles": [
280
- "admin"
281
- ],
282
- "route": {
283
- "verb": "POST",
284
- "path": "/unsuspend"
285
- },
286
- "task": true
287
- },
288
- {
289
- "name": "getQueue",
290
- "summary": "Return the requests that are waiting in the queue if throttling is enabled",
291
- "description": "Return the requests that are waiting in the queue if throttling is enabled",
292
- "input": [],
293
- "output": {
294
- "name": "result",
295
- "type": "object",
296
- "description": "A JSON Object containing the adapter queue",
297
- "schema": {
298
- "title": "result",
299
- "type": "object"
300
- }
301
- },
302
- "roles": [
303
- "admin"
304
- ],
305
- "route": {
306
- "verb": "POST",
307
- "path": "/getQueue"
308
- },
309
- "task": true
310
- },
311
- {
312
- "name": "genericAdapterRequest",
313
- "summary": "Makes the requested generic call",
314
- "description": "Makes the requested generic call",
315
- "input": [
316
- {
317
- "name": "uriPath",
318
- "type": "string",
319
- "info": "the path of the api call - do not include the host, port, base path or version",
320
- "description": "the path of the api call",
321
- "schema": {
322
- "title": "uriPath",
323
- "type": "string"
324
- },
325
- "required": true
326
- },
327
- {
328
- "name": "restMethod",
329
- "type": "string",
330
- "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
331
- "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
332
- "schema": {
333
- "title": "restMethod",
334
- "type": "string"
335
- },
336
- "required": true
337
- },
338
- {
339
- "name": "queryData",
340
- "type": "object",
341
- "info": "the query parameters to be put on the url (optional)",
342
- "description": "the query parameters to be put on the url (optional)",
343
- "schema": {
344
- "title": "queryData",
345
- "type": "object"
346
- },
347
- "required": false
348
- },
349
- {
350
- "name": "requestBody",
351
- "type": "object",
352
- "info": "the payload to be sent with the request (optional)",
353
- "description": "the payload to be sent with the request (optional)",
354
- "schema": {
355
- "title": "requestBody",
356
- "type": "object"
357
- },
358
- "required": false
359
- },
360
- {
361
- "name": "addlHeaders",
362
- "type": "object",
363
- "info": "additional headers to be put on the call (optional)",
364
- "description": "additional headers to be put on the call (optional)",
365
- "schema": {
366
- "title": "addlHeaders",
367
- "type": "object"
368
- },
369
- "required": false
370
- }
371
- ],
372
- "output": {
373
- "name": "result",
374
- "type": "object",
375
- "description": "A JSON Object containing status, code and the result",
376
- "schema": {
377
- "title": "result",
378
- "type": "object"
379
- }
380
- },
381
- "roles": [
382
- "admin"
383
- ],
384
- "route": {
385
- "verb": "POST",
386
- "path": "/genericAdapterRequest"
387
- },
388
- "task": true
389
- },
12
+ {
13
+ "name": "iapUpdateAdapterConfiguration",
14
+ "summary": "Updates the adapter configuration",
15
+ "description": "Updates the adapter configuration file with the provided changes",
16
+ "input": [
17
+ {
18
+ "name": "configFile",
19
+ "type": "string",
20
+ "info": "The name of the file to change",
21
+ "required": true,
22
+ "schema": {
23
+ "title": "configFile",
24
+ "type": "string"
25
+ }
26
+ },
27
+ {
28
+ "name": "changes",
29
+ "type": "object",
30
+ "info": "JSON object containing the configuration changes",
31
+ "required": true,
32
+ "schema": {
33
+ "title": "changes",
34
+ "type": "object"
35
+ }
36
+ },
37
+ {
38
+ "name": "entity",
39
+ "type": "string",
40
+ "info": "The entity in which the changes are being made",
41
+ "required": false,
42
+ "schema": {
43
+ "title": "entity",
44
+ "type": "string"
45
+ }
46
+ },
47
+ {
48
+ "name": "type",
49
+ "type": "string",
50
+ "info": "The type of file to change - action, schema, or mock",
51
+ "required": false,
52
+ "schema": {
53
+ "title": "type",
54
+ "type": "string"
55
+ }
56
+ },
57
+ {
58
+ "name": "action",
59
+ "type": "string",
60
+ "info": "The action to be changed",
61
+ "required": false,
62
+ "schema": {
63
+ "title": "action",
64
+ "type": "string"
65
+ }
66
+ }
67
+ ],
68
+ "output": {
69
+ "name": "result",
70
+ "type": "object",
71
+ "description": "A JSON Object containing status, code and the result",
72
+ "schema": {
73
+ "title": "result",
74
+ "type": "object"
75
+ }
76
+ },
77
+ "roles": [
78
+ "admin"
79
+ ],
80
+ "route": {
81
+ "verb": "POST",
82
+ "path": "/iapUpdateAdapterConfiguration"
83
+ },
84
+ "task": true
85
+ },
86
+ {
87
+ "name": "iapFindAdapterPath",
88
+ "summary": "Provides the ability to see if a particular API path is supported by the adapter",
89
+ "description": "Provides the ability to see if a particular API path is supported by the adapter",
90
+ "input": [{
91
+ "name": "apiPath",
92
+ "type": "string",
93
+ "info": "The API Path you want to check - make sure to not include base path and version",
94
+ "description": "The API Path you want to check - make sure to not include base path and version",
95
+ "schema": {
96
+ "title": "apiPath",
97
+ "type": "string"
98
+ },
99
+ "required": true
100
+ }],
101
+ "output": {
102
+ "name": "result",
103
+ "type": "object",
104
+ "description": "A JSON Object containing the result",
105
+ "schema": {
106
+ "title": "result",
107
+ "type": "object"
108
+ }
109
+ },
110
+ "roles": [
111
+ "admin"
112
+ ],
113
+ "route": {
114
+ "verb": "POST",
115
+ "path": "/iapFindAdapterPath"
116
+ },
117
+ "task": true
118
+ },
119
+ {
120
+ "name": "iapSuspendAdapter",
121
+ "summary": "Suspends the adapter",
122
+ "description": "Suspends the adapter",
123
+ "input": [{
124
+ "name": "mode",
125
+ "type": "enum",
126
+ "enumerals": ["pause", "error"],
127
+ "info": "How incoming requests are handled. Defaults to 'pause'",
128
+ "description": "How incoming requests are handled. Defaults to 'pause'",
129
+ "schema": {
130
+ "title": "mode",
131
+ "type": "string"
132
+ },
133
+ "required": false
134
+ }],
135
+ "output": {
136
+ "name": "result",
137
+ "type": "object",
138
+ "description": "A JSON Object containing the adapter suspended status",
139
+ "schema": {
140
+ "title": "result",
141
+ "type": "object"
142
+ }
143
+ },
144
+ "roles": [
145
+ "admin"
146
+ ],
147
+ "route": {
148
+ "verb": "POST",
149
+ "path": "/iapSuspendAdapter"
150
+ },
151
+ "task": true
152
+ },
153
+ {
154
+ "name": "iapUnsuspendAdapter",
155
+ "summary": "Unsuspends the adapter",
156
+ "description": "Unsuspends the adapter",
157
+ "input": [],
158
+ "output": {
159
+ "name": "result",
160
+ "type": "object",
161
+ "description": "A JSON Object containing the adapter suspended status",
162
+ "schema": {
163
+ "title": "result",
164
+ "type": "object"
165
+ }
166
+ },
167
+ "roles": [
168
+ "admin"
169
+ ],
170
+ "route": {
171
+ "verb": "POST",
172
+ "path": "/iapUnsuspendAdapter"
173
+ },
174
+ "task": true
175
+ },
176
+ {
177
+ "name": "iapGetAdapterQueue",
178
+ "summary": "Return the requests that are waiting in the queue if throttling is enabled",
179
+ "description": "Return the requests that are waiting in the queue if throttling is enabled",
180
+ "input": [],
181
+ "output": {
182
+ "name": "result",
183
+ "type": "object",
184
+ "description": "A JSON Object containing the adapter queue",
185
+ "schema": {
186
+ "title": "result",
187
+ "type": "object"
188
+ }
189
+ },
190
+ "roles": [
191
+ "admin"
192
+ ],
193
+ "route": {
194
+ "verb": "POST",
195
+ "path": "/iapGetAdapterQueue"
196
+ },
197
+ "task": true
198
+ },
199
+ {
200
+ "name": "iapTroubleshootAdapter",
201
+ "summary": "Runs troubleshoot script for adapter",
202
+ "description": "Runs troubleshoot script for adapter",
203
+ "input": [
204
+ {
205
+ "name": "props",
206
+ "type": "object",
207
+ "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
208
+ "required": true,
209
+ "schema": {
210
+ "title": "props",
211
+ "type": "object"
212
+ }
213
+ },
214
+ {
215
+ "name": "persistFlag",
216
+ "type": "boolean",
217
+ "info": "Whether the input properties should be saved",
218
+ "required": true
219
+ }
220
+ ],
221
+ "output": {
222
+ "name": "result",
223
+ "type": "object",
224
+ "description": "A JSON Object containing the test results",
225
+ "schema": {
226
+ "title": "result",
227
+ "type": "object"
228
+ }
229
+ },
230
+ "roles": [
231
+ "admin"
232
+ ],
233
+ "route": {
234
+ "verb": "POST",
235
+ "path": "/iapTroubleshootAdapter"
236
+ },
237
+ "task": true
238
+ },
239
+ {
240
+ "name": "iapRunAdapterHealthcheck",
241
+ "summary": "Runs healthcheck script for adapter",
242
+ "description": "Runs healthcheck script for adapter",
243
+ "input": [],
244
+ "output": {
245
+ "name": "result",
246
+ "type": "boolean",
247
+ "description": "Whether healthcheck passed or failed"
248
+ },
249
+ "roles": [
250
+ "admin"
251
+ ],
252
+ "route": {
253
+ "verb": "POST",
254
+ "path": "/iapRunAdapterHealthcheck"
255
+ },
256
+ "task": true
257
+ },
258
+ {
259
+ "name": "iapRunAdapterConnectivity",
260
+ "summary": "Runs connectivity check script for adapter",
261
+ "description": "Runs connectivity check script for adapter",
262
+ "input": [],
263
+ "output": {
264
+ "name": "result",
265
+ "type": "object",
266
+ "description": "A JSON Object containing the test results",
267
+ "schema": {
268
+ "title": "result",
269
+ "type": "object"
270
+ }
271
+ },
272
+ "roles": [
273
+ "admin"
274
+ ],
275
+ "route": {
276
+ "verb": "POST",
277
+ "path": "/iapRunAdapterConnectivity"
278
+ },
279
+ "task": true
280
+ },
281
+ {
282
+ "name": "iapRunAdapterBasicGet",
283
+ "summary": "Runs basicGet script for adapter",
284
+ "description": "Runs basicGet script for adapter",
285
+ "input": [],
286
+ "output": {
287
+ "name": "result",
288
+ "type": "object",
289
+ "description": "A JSON Object containing the test results",
290
+ "schema": {
291
+ "title": "result",
292
+ "type": "object"
293
+ }
294
+ },
295
+ "roles": [
296
+ "admin"
297
+ ],
298
+ "route": {
299
+ "verb": "POST",
300
+ "path": "/iapRunAdapterBasicGet"
301
+ },
302
+ "task": true
303
+ },
304
+ {
305
+ "name": "iapMoveAdapterEntitiesToDB",
306
+ "summary": "Moves entities from an adapter into the IAP database",
307
+ "description": "Moves entities from an adapter into the IAP database",
308
+ "input": [],
309
+ "output": {
310
+ "name": "res",
311
+ "type": "object",
312
+ "description": "A JSON Object containing status, code and the response from the mongo transaction",
313
+ "schema": {
314
+ "title": "res",
315
+ "type": "object"
316
+ }
317
+ },
318
+ "roles": [
319
+ "admin"
320
+ ],
321
+ "route": {
322
+ "verb": "POST",
323
+ "path": "/iapMoveAdapterEntitiesToDB"
324
+ },
325
+ "task": true
326
+ },
327
+ {
328
+ "name": "genericAdapterRequest",
329
+ "summary": "Makes the requested generic call",
330
+ "description": "Makes the requested generic call",
331
+ "input": [
332
+ {
333
+ "name": "uriPath",
334
+ "type": "string",
335
+ "info": "the path of the api call - do not include the host, port, base path or version",
336
+ "description": "the path of the api call",
337
+ "schema": {
338
+ "title": "uriPath",
339
+ "type": "string"
340
+ },
341
+ "required": true
342
+ },
343
+ {
344
+ "name": "restMethod",
345
+ "type": "string",
346
+ "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
347
+ "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
348
+ "schema": {
349
+ "title": "restMethod",
350
+ "type": "string"
351
+ },
352
+ "required": true
353
+ },
354
+ {
355
+ "name": "queryData",
356
+ "type": "object",
357
+ "info": "the query parameters to be put on the url (optional)",
358
+ "description": "the query parameters to be put on the url (optional)",
359
+ "schema": {
360
+ "title": "queryData",
361
+ "type": "object"
362
+ },
363
+ "required": false
364
+ },
365
+ {
366
+ "name": "requestBody",
367
+ "type": "object",
368
+ "info": "the payload to be sent with the request (optional)",
369
+ "description": "the payload to be sent with the request (optional)",
370
+ "schema": {
371
+ "title": "requestBody",
372
+ "type": "object"
373
+ },
374
+ "required": false
375
+ },
376
+ {
377
+ "name": "addlHeaders",
378
+ "type": "object",
379
+ "info": "additional headers to be put on the call (optional)",
380
+ "description": "additional headers to be put on the call (optional)",
381
+ "schema": {
382
+ "title": "addlHeaders",
383
+ "type": "object"
384
+ },
385
+ "required": false
386
+ }
387
+ ],
388
+ "output": {
389
+ "name": "result",
390
+ "type": "object",
391
+ "description": "A JSON Object containing status, code and the result",
392
+ "schema": {
393
+ "title": "result",
394
+ "type": "object"
395
+ }
396
+ },
397
+ "roles": [
398
+ "admin"
399
+ ],
400
+ "route": {
401
+ "verb": "POST",
402
+ "path": "/genericAdapterRequest"
403
+ },
404
+ "task": true
405
+ },
406
+ {
407
+ "name": "genericAdapterRequestNoBasePath",
408
+ "summary": "Makes the requested generic call with no base path or version",
409
+ "description": "Makes the requested generic call with no base path or version",
410
+ "input": [
411
+ {
412
+ "name": "uriPath",
413
+ "type": "string",
414
+ "info": "the path of the api call - do not include the host, port, base path or version",
415
+ "description": "the path of the api call",
416
+ "schema": {
417
+ "title": "uriPath",
418
+ "type": "string"
419
+ },
420
+ "required": true
421
+ },
422
+ {
423
+ "name": "restMethod",
424
+ "type": "string",
425
+ "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
426
+ "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
427
+ "schema": {
428
+ "title": "restMethod",
429
+ "type": "string"
430
+ },
431
+ "required": true
432
+ },
433
+ {
434
+ "name": "queryData",
435
+ "type": "object",
436
+ "info": "the query parameters to be put on the url (optional)",
437
+ "description": "the query parameters to be put on the url (optional)",
438
+ "schema": {
439
+ "title": "queryData",
440
+ "type": "object"
441
+ },
442
+ "required": false
443
+ },
444
+ {
445
+ "name": "requestBody",
446
+ "type": "object",
447
+ "info": "the payload to be sent with the request (optional)",
448
+ "description": "the payload to be sent with the request (optional)",
449
+ "schema": {
450
+ "title": "requestBody",
451
+ "type": "object"
452
+ },
453
+ "required": false
454
+ },
455
+ {
456
+ "name": "addlHeaders",
457
+ "type": "object",
458
+ "info": "additional headers to be put on the call (optional)",
459
+ "description": "additional headers to be put on the call (optional)",
460
+ "schema": {
461
+ "title": "addlHeaders",
462
+ "type": "object"
463
+ },
464
+ "required": false
465
+ }
466
+ ],
467
+ "output": {
468
+ "name": "result",
469
+ "type": "object",
470
+ "description": "A JSON Object containing status, code and the result",
471
+ "schema": {
472
+ "title": "result",
473
+ "type": "object"
474
+ }
475
+ },
476
+ "roles": [
477
+ "admin"
478
+ ],
479
+ "route": {
480
+ "verb": "POST",
481
+ "path": "/genericAdapterRequestNoBasePath"
482
+ },
483
+ "task": true
484
+ },
485
+ {
486
+ "name": "getDevice",
487
+ "summary": "Get the Appliance",
488
+ "description": "Get the Appliance",
489
+ "input": [
490
+ {
491
+ "name": "deviceName",
492
+ "type": "string",
493
+ "info": "An Appliance Device Name",
494
+ "required": true,
495
+ "schema": {
496
+ "title": "deviceName",
497
+ "type": "string"
498
+ }
499
+ }
500
+ ],
501
+ "output": {
502
+ "name": "result",
503
+ "type": "object",
504
+ "description": "A JSON Object containing status, code and the result",
505
+ "schema": {
506
+ "title": "result",
507
+ "type": "object"
508
+ }
509
+ },
510
+ "roles": [
511
+ "admin"
512
+ ],
513
+ "route": {
514
+ "verb": "POST",
515
+ "path": "/getDevice"
516
+ },
517
+ "task": false
518
+ },
519
+ {
520
+ "name": "getDevicesFiltered",
521
+ "summary": "Get Appliances that match the filter",
522
+ "description": "Get Appliances that match the filter",
523
+ "input": [
524
+ {
525
+ "name": "options",
526
+ "type": "object",
527
+ "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
528
+ "required": true,
529
+ "schema": {
530
+ "title": "options",
531
+ "type": "object"
532
+ }
533
+ }
534
+ ],
535
+ "output": {
536
+ "name": "result",
537
+ "type": "array",
538
+ "description": "A JSON Object containing status, code and the result",
539
+ "schema": {
540
+ "title": "result",
541
+ "type": "array"
542
+ }
543
+ },
544
+ "roles": [
545
+ "admin"
546
+ ],
547
+ "route": {
548
+ "verb": "POST",
549
+ "path": "/getDevicesFiltered"
550
+ },
551
+ "task": false
552
+ },
553
+ {
554
+ "name": "isAlive",
555
+ "summary": "Checks the status for the provided Appliance",
556
+ "description": "Checks the status for the provided Appliance",
557
+ "input": [
558
+ {
559
+ "name": "deviceName",
560
+ "type": "string",
561
+ "info": "An Appliance Device Name",
562
+ "required": true,
563
+ "schema": {
564
+ "title": "deviceName",
565
+ "type": "string"
566
+ }
567
+ }
568
+ ],
569
+ "output": {
570
+ "name": "result",
571
+ "type": "boolean",
572
+ "description": "A JSON Object containing status, code and the result",
573
+ "schema": {
574
+ "title": "result",
575
+ "type": "boolean"
576
+ }
577
+ },
578
+ "roles": [
579
+ "admin"
580
+ ],
581
+ "route": {
582
+ "verb": "POST",
583
+ "path": "/isAlive"
584
+ },
585
+ "task": false
586
+ },
587
+ {
588
+ "name": "getConfig",
589
+ "summary": "Gets a config for the provided Appliance",
590
+ "description": "Gets a config for the provided Appliance",
591
+ "input": [
592
+ {
593
+ "name": "deviceName",
594
+ "type": "string",
595
+ "info": "An Appliance Device Name",
596
+ "required": true,
597
+ "schema": {
598
+ "title": "deviceName",
599
+ "type": "string"
600
+ }
601
+ },
602
+ {
603
+ "name": "format",
604
+ "type": "string",
605
+ "info": "The format to be returned - this is ignored as we always return json",
606
+ "required": false,
607
+ "schema": {
608
+ "title": "format",
609
+ "type": "string"
610
+ }
611
+ }
612
+ ],
613
+ "output": {
614
+ "name": "result",
615
+ "type": "object",
616
+ "description": "A JSON Object containing status, code and the result",
617
+ "schema": {
618
+ "title": "result",
619
+ "type": "object"
620
+ }
621
+ },
622
+ "roles": [
623
+ "admin"
624
+ ],
625
+ "route": {
626
+ "verb": "POST",
627
+ "path": "/getConfig"
628
+ },
629
+ "task": false
630
+ },
631
+ {
632
+ "name": "iapGetDeviceCount",
633
+ "summary": "Gets a device count from the system",
634
+ "description": "Gets a device count from the system",
635
+ "input": [],
636
+ "output": {
637
+ "name": "result",
638
+ "type": "object",
639
+ "description": "A JSON Object containing status, code and the result",
640
+ "schema": {
641
+ "title": "result",
642
+ "type": "object"
643
+ }
644
+ },
645
+ "roles": [
646
+ "admin"
647
+ ],
648
+ "route": {
649
+ "verb": "POST",
650
+ "path": "/iapGetDeviceCount"
651
+ },
652
+ "task": false
653
+ },
390
654
  {
391
655
  "name": "getV4ApplicationSettings",
392
656
  "summary": "Get the current application settings",
@@ -17020,6 +17284,16 @@
17020
17284
  "title": "filePath",
17021
17285
  "type": "string"
17022
17286
  }
17287
+ },
17288
+ {
17289
+ "name": "body",
17290
+ "type": "object",
17291
+ "info": "the payload to send with the request",
17292
+ "required": true,
17293
+ "schema": {
17294
+ "title": "body",
17295
+ "type": "object"
17296
+ }
17023
17297
  }
17024
17298
  ],
17025
17299
  "output": {