@itentialopensource/adapter-meraki 0.8.1 → 0.8.4

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