@itentialopensource/adapter-azure_devops 0.1.10 → 0.2.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 (46) hide show
  1. package/AUTH.md +11 -13
  2. package/CALLS.md +797 -22
  3. package/CHANGELOG.md +16 -0
  4. package/CONTRIBUTING.md +1 -160
  5. package/ENHANCE.md +2 -2
  6. package/README.md +32 -23
  7. package/SYSTEMINFO.md +13 -5
  8. package/adapter.js +163 -335
  9. package/adapterBase.js +549 -879
  10. package/changelogs/CHANGELOG.md +88 -0
  11. package/metadata.json +73 -0
  12. package/package.json +24 -25
  13. package/pronghorn.json +980 -641
  14. package/propertiesSchema.json +431 -31
  15. package/refs?service=git-upload-pack +0 -0
  16. package/report/adapter-openapi.json +29422 -0
  17. package/report/adapter-openapi.yaml +10963 -0
  18. package/report/adapterInfo.json +8 -8
  19. package/report/updateReport1691507719192.json +120 -0
  20. package/report/updateReport1692202716318.json +120 -0
  21. package/report/updateReport1694455416503.json +120 -0
  22. package/report/updateReport1694457083247.json +120 -0
  23. package/report/updateReport1694462876098.json +120 -0
  24. package/report/updateReport1698421291981.json +120 -0
  25. package/sampleProperties.json +63 -2
  26. package/test/integration/adapterTestBasicGet.js +2 -4
  27. package/test/integration/adapterTestConnectivity.js +91 -42
  28. package/test/integration/adapterTestIntegration.js +130 -2
  29. package/test/unit/adapterBaseTestUnit.js +388 -313
  30. package/test/unit/adapterTestUnit.js +338 -112
  31. package/utils/adapterInfo.js +1 -1
  32. package/utils/addAuth.js +1 -1
  33. package/utils/artifactize.js +1 -1
  34. package/utils/checkMigrate.js +1 -1
  35. package/utils/entitiesToDB.js +2 -2
  36. package/utils/findPath.js +1 -1
  37. package/utils/methodDocumentor.js +273 -0
  38. package/utils/modify.js +13 -15
  39. package/utils/packModificationScript.js +1 -1
  40. package/utils/pre-commit.sh +2 -0
  41. package/utils/taskMover.js +309 -0
  42. package/utils/tbScript.js +89 -34
  43. package/utils/tbUtils.js +41 -21
  44. package/utils/testRunner.js +1 -1
  45. package/utils/troubleshootingAdapter.js +9 -6
  46. package/workflows/README.md +0 -3
package/pronghorn.json CHANGED
@@ -9,647 +9,986 @@
9
9
  ],
10
10
  "methods": [
11
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
- },
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
+ "name": "replace",
68
+ "type": "boolean",
69
+ "info": "True to replace entire mock data, false to merge/append",
70
+ "required": false,
71
+ "schema": {
72
+ "title": "replace",
73
+ "type": "boolean"
74
+ }
75
+ }
76
+ ],
77
+ "output": {
78
+ "name": "result",
79
+ "type": "object",
80
+ "description": "A JSON Object containing status, code and the result",
81
+ "schema": {
82
+ "title": "result",
83
+ "type": "object"
84
+ }
85
+ },
86
+ "roles": [
87
+ "admin"
88
+ ],
89
+ "route": {
90
+ "verb": "POST",
91
+ "path": "/iapUpdateAdapterConfiguration"
92
+ },
93
+ "task": true
94
+ },
95
+ {
96
+ "name": "iapSuspendAdapter",
97
+ "summary": "Suspends the adapter",
98
+ "description": "Suspends the adapter",
99
+ "input": [
100
+ {
101
+ "name": "mode",
102
+ "type": "enum",
103
+ "enumerals": [
104
+ "pause",
105
+ "error"
106
+ ],
107
+ "info": "How incoming requests are handled. Defaults to 'pause'",
108
+ "description": "How incoming requests are handled. Defaults to 'pause'",
109
+ "schema": {
110
+ "title": "mode",
111
+ "type": "string"
112
+ },
113
+ "required": false
114
+ }
115
+ ],
116
+ "output": {
117
+ "name": "result",
118
+ "type": "object",
119
+ "description": "A JSON Object containing the adapter suspended status",
120
+ "schema": {
121
+ "title": "result",
122
+ "type": "object"
123
+ }
124
+ },
125
+ "roles": [
126
+ "admin"
127
+ ],
128
+ "route": {
129
+ "verb": "POST",
130
+ "path": "/iapSuspendAdapter"
131
+ },
132
+ "task": true
133
+ },
134
+ {
135
+ "name": "iapUnsuspendAdapter",
136
+ "summary": "Unsuspends the adapter",
137
+ "description": "Unsuspends the adapter",
138
+ "input": [],
139
+ "output": {
140
+ "name": "result",
141
+ "type": "object",
142
+ "description": "A JSON Object containing the adapter suspended status",
143
+ "schema": {
144
+ "title": "result",
145
+ "type": "object"
146
+ }
147
+ },
148
+ "roles": [
149
+ "admin"
150
+ ],
151
+ "route": {
152
+ "verb": "POST",
153
+ "path": "/iapUnsuspendAdapter"
154
+ },
155
+ "task": true
156
+ },
157
+ {
158
+ "name": "iapGetAdapterQueue",
159
+ "summary": "Return the requests that are waiting in the queue if throttling is enabled",
160
+ "description": "Return the requests that are waiting in the queue if throttling is enabled",
161
+ "input": [],
162
+ "output": {
163
+ "name": "result",
164
+ "type": "object",
165
+ "description": "A JSON Object containing the adapter queue",
166
+ "schema": {
167
+ "title": "result",
168
+ "type": "object"
169
+ }
170
+ },
171
+ "roles": [
172
+ "admin"
173
+ ],
174
+ "route": {
175
+ "verb": "POST",
176
+ "path": "/iapGetAdapterQueue"
177
+ },
178
+ "task": true
179
+ },
180
+ {
181
+ "name": "iapFindAdapterPath",
182
+ "summary": "Provides the ability to see if a particular API path is supported by the adapter",
183
+ "description": "Provides the ability to see if a particular API path is supported by the adapter",
184
+ "input": [
185
+ {
186
+ "name": "apiPath",
187
+ "type": "string",
188
+ "info": "The API Path you want to check - make sure to not include base path and version",
189
+ "description": "The API Path you want to check - make sure to not include base path and version",
190
+ "schema": {
191
+ "title": "apiPath",
192
+ "type": "string"
193
+ },
194
+ "required": true
195
+ }
196
+ ],
197
+ "output": {
198
+ "name": "result",
199
+ "type": "object",
200
+ "description": "A JSON Object containing the result",
201
+ "schema": {
202
+ "title": "result",
203
+ "type": "object"
204
+ }
205
+ },
206
+ "roles": [
207
+ "admin"
208
+ ],
209
+ "route": {
210
+ "verb": "POST",
211
+ "path": "/iapFindAdapterPath"
212
+ },
213
+ "task": true
214
+ },
215
+ {
216
+ "name": "iapTroubleshootAdapter",
217
+ "summary": "Runs troubleshoot script for adapter",
218
+ "description": "Runs troubleshoot script for adapter",
219
+ "input": [
220
+ {
221
+ "name": "props",
222
+ "type": "object",
223
+ "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'}}",
224
+ "required": true,
225
+ "schema": {
226
+ "title": "props",
227
+ "type": "object"
228
+ }
229
+ },
230
+ {
231
+ "name": "persistFlag",
232
+ "type": "boolean",
233
+ "info": "Whether the input properties should be saved",
234
+ "required": true,
235
+ "schema": {
236
+ "title": "persistFlag",
237
+ "type": "boolean"
238
+ }
239
+ }
240
+ ],
241
+ "output": {
242
+ "name": "result",
243
+ "type": "object",
244
+ "description": "A JSON Object containing the test results",
245
+ "schema": {
246
+ "title": "result",
247
+ "type": "object"
248
+ }
249
+ },
250
+ "roles": [
251
+ "admin"
252
+ ],
253
+ "route": {
254
+ "verb": "POST",
255
+ "path": "/iapTroubleshootAdapter"
256
+ },
257
+ "task": true
258
+ },
259
+ {
260
+ "name": "iapRunAdapterHealthcheck",
261
+ "summary": "Runs healthcheck script for adapter",
262
+ "description": "Runs healthcheck script for adapter",
263
+ "input": [],
264
+ "output": {
265
+ "name": "result",
266
+ "type": "boolean",
267
+ "description": "Whether healthcheck passed or failed",
268
+ "schema": {
269
+ "title": "result",
270
+ "type": "boolean"
271
+ }
272
+ },
273
+ "roles": [
274
+ "admin"
275
+ ],
276
+ "route": {
277
+ "verb": "POST",
278
+ "path": "/iapRunAdapterHealthcheck"
279
+ },
280
+ "task": true
281
+ },
282
+ {
283
+ "name": "iapRunAdapterConnectivity",
284
+ "summary": "Runs connectivity check script for adapter",
285
+ "description": "Runs connectivity check script for adapter",
286
+ "input": [],
287
+ "output": {
288
+ "name": "result",
289
+ "type": "object",
290
+ "description": "A JSON Object containing the test results",
291
+ "schema": {
292
+ "title": "result",
293
+ "type": "object"
294
+ }
295
+ },
296
+ "roles": [
297
+ "admin"
298
+ ],
299
+ "route": {
300
+ "verb": "POST",
301
+ "path": "/iapRunAdapterConnectivity"
302
+ },
303
+ "task": true
304
+ },
305
+ {
306
+ "name": "iapRunAdapterBasicGet",
307
+ "summary": "Runs basicGet script for adapter",
308
+ "description": "Runs basicGet script for adapter",
309
+ "input": [],
310
+ "output": {
311
+ "name": "result",
312
+ "type": "object",
313
+ "description": "A JSON Object containing the test results",
314
+ "schema": {
315
+ "title": "result",
316
+ "type": "object"
317
+ }
318
+ },
319
+ "roles": [
320
+ "admin"
321
+ ],
322
+ "route": {
323
+ "verb": "POST",
324
+ "path": "/iapRunAdapterBasicGet"
325
+ },
326
+ "task": true
327
+ },
328
+ {
329
+ "name": "iapMoveAdapterEntitiesToDB",
330
+ "summary": "Moves entities from an adapter into the IAP database",
331
+ "description": "Moves entities from an adapter into the IAP database",
332
+ "input": [],
333
+ "output": {
334
+ "name": "res",
335
+ "type": "object",
336
+ "description": "A JSON Object containing status, code and the response from the mongo transaction",
337
+ "schema": {
338
+ "title": "res",
339
+ "type": "object"
340
+ }
341
+ },
342
+ "roles": [
343
+ "admin"
344
+ ],
345
+ "route": {
346
+ "verb": "POST",
347
+ "path": "/iapMoveAdapterEntitiesToDB"
348
+ },
349
+ "task": true
350
+ },
351
+ {
352
+ "name": "iapDeactivateTasks",
353
+ "summary": "Deactivate the inputted tasks",
354
+ "description": "Deactivate the inputted tasks",
355
+ "input": [
356
+ {
357
+ "name": "tasks",
358
+ "type": "array",
359
+ "description": "Tasks to deactivate",
360
+ "schema": {
361
+ "title": "tasks",
362
+ "type": "array"
363
+ }
364
+ }
365
+ ],
366
+ "output": {
367
+ "name": "result",
368
+ "type": "object",
369
+ "description": "A JSON Object containing success status",
370
+ "schema": {
371
+ "title": "result",
372
+ "type": "object"
373
+ }
374
+ },
375
+ "roles": [
376
+ "admin"
377
+ ],
378
+ "route": {
379
+ "verb": "POST",
380
+ "path": "/iapDeactivateTasks"
381
+ },
382
+ "task": true
383
+ },
384
+ {
385
+ "name": "iapActivateTasks",
386
+ "summary": "Activate the inputted tasks",
387
+ "description": "activate the inputted tasks",
388
+ "input": [
389
+ {
390
+ "name": "tasks",
391
+ "type": "array",
392
+ "description": "Tasks to activate",
393
+ "schema": {
394
+ "title": "tasks",
395
+ "type": "array"
396
+ }
397
+ }
398
+ ],
399
+ "output": {
400
+ "name": "result",
401
+ "type": "object",
402
+ "description": "A JSON Object containing success status",
403
+ "schema": {
404
+ "title": "result",
405
+ "type": "object"
406
+ }
407
+ },
408
+ "roles": [
409
+ "admin"
410
+ ],
411
+ "route": {
412
+ "verb": "POST",
413
+ "path": "/iapActivateTasks"
414
+ },
415
+ "task": true
416
+ },
417
+ {
418
+ "name": "iapPopulateEntityCache",
419
+ "summary": "Populate the cache for the given entities",
420
+ "description": "Populate the cache for the given entities",
421
+ "input": [
422
+ {
423
+ "name": "entityTypes",
424
+ "type": "array",
425
+ "info": "the entity type(s) to populate",
426
+ "required": true,
427
+ "schema": {
428
+ "title": "entityTypes",
429
+ "type": "array"
430
+ }
431
+ }
432
+ ],
433
+ "output": {
434
+ "name": "result",
435
+ "type": "object",
436
+ "description": "A JSON Object containing status, code and the result",
437
+ "schema": {
438
+ "title": "result",
439
+ "type": "object"
440
+ }
441
+ },
442
+ "roles": [
443
+ "admin"
444
+ ],
445
+ "route": {
446
+ "verb": "POST",
447
+ "path": "/iapPopulateEntityCache"
448
+ },
449
+ "task": true
450
+ },
451
+ {
452
+ "name": "iapRetrieveEntitiesCache",
453
+ "summary": "Retrieves data from cache for specified entity type",
454
+ "description": "Retrieves data from cache for specified entity type",
455
+ "input": [
456
+ {
457
+ "name": "entityType",
458
+ "type": "string",
459
+ "info": "entity of which to retrieve",
460
+ "required": true,
461
+ "schema": {
462
+ "title": "entityType",
463
+ "type": "string"
464
+ }
465
+ },
466
+ {
467
+ "name": "options",
468
+ "type": "object",
469
+ "info": "settings of which data to return and how to return it",
470
+ "required": false,
471
+ "schema": {
472
+ "title": "options",
473
+ "type": "object"
474
+ }
475
+ }
476
+ ],
477
+ "output": {
478
+ "name": "result",
479
+ "type": "object",
480
+ "description": "A JSON Object containing status, code and the result",
481
+ "schema": {
482
+ "title": "result",
483
+ "type": "object"
484
+ }
485
+ },
486
+ "roles": [
487
+ "admin"
488
+ ],
489
+ "route": {
490
+ "verb": "POST",
491
+ "path": "/iapRetrieveEntitiesCache"
492
+ },
493
+ "task": true
494
+ },
495
+ {
496
+ "name": "getDevice",
497
+ "summary": "Get the Appliance",
498
+ "description": "Get the Appliance",
499
+ "input": [
500
+ {
501
+ "name": "deviceName",
502
+ "type": "string",
503
+ "info": "An Appliance Device Name",
504
+ "required": true,
505
+ "schema": {
506
+ "title": "deviceName",
507
+ "type": "string"
508
+ }
509
+ }
510
+ ],
511
+ "output": {
512
+ "name": "result",
513
+ "type": "object",
514
+ "description": "A JSON Object containing status, code and the result",
515
+ "schema": {
516
+ "title": "result",
517
+ "type": "object"
518
+ }
519
+ },
520
+ "roles": [
521
+ "admin"
522
+ ],
523
+ "route": {
524
+ "verb": "POST",
525
+ "path": "/getDevice"
526
+ },
527
+ "task": false
528
+ },
529
+ {
530
+ "name": "getDevicesFiltered",
531
+ "summary": "Get Appliances that match the filter",
532
+ "description": "Get Appliances that match the filter",
533
+ "input": [
534
+ {
535
+ "name": "options",
536
+ "type": "object",
537
+ "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
538
+ "required": true,
539
+ "schema": {
540
+ "title": "options",
541
+ "type": "object"
542
+ }
543
+ }
544
+ ],
545
+ "output": {
546
+ "name": "result",
547
+ "type": "array",
548
+ "description": "A JSON Object containing status, code and the result",
549
+ "schema": {
550
+ "title": "result",
551
+ "type": "array"
552
+ }
553
+ },
554
+ "roles": [
555
+ "admin"
556
+ ],
557
+ "route": {
558
+ "verb": "POST",
559
+ "path": "/getDevicesFiltered"
560
+ },
561
+ "task": false
562
+ },
563
+ {
564
+ "name": "isAlive",
565
+ "summary": "Checks the status for the provided Appliance",
566
+ "description": "Checks the status for the provided Appliance",
567
+ "input": [
568
+ {
569
+ "name": "deviceName",
570
+ "type": "string",
571
+ "info": "An Appliance Device Name",
572
+ "required": true,
573
+ "schema": {
574
+ "title": "deviceName",
575
+ "type": "string"
576
+ }
577
+ }
578
+ ],
579
+ "output": {
580
+ "name": "result",
581
+ "type": "boolean",
582
+ "description": "A JSON Object containing status, code and the result",
583
+ "schema": {
584
+ "title": "result",
585
+ "type": "boolean"
586
+ }
587
+ },
588
+ "roles": [
589
+ "admin"
590
+ ],
591
+ "route": {
592
+ "verb": "POST",
593
+ "path": "/isAlive"
594
+ },
595
+ "task": false
596
+ },
597
+ {
598
+ "name": "getConfig",
599
+ "summary": "Gets a config for the provided Appliance",
600
+ "description": "Gets a config for the provided Appliance",
601
+ "input": [
602
+ {
603
+ "name": "deviceName",
604
+ "type": "string",
605
+ "info": "An Appliance Device Name",
606
+ "required": true,
607
+ "schema": {
608
+ "title": "deviceName",
609
+ "type": "string"
610
+ }
611
+ },
612
+ {
613
+ "name": "format",
614
+ "type": "string",
615
+ "info": "The format to be returned - this is ignored as we always return json",
616
+ "required": false,
617
+ "schema": {
618
+ "title": "format",
619
+ "type": "string"
620
+ }
621
+ }
622
+ ],
623
+ "output": {
624
+ "name": "result",
625
+ "type": "object",
626
+ "description": "A JSON Object containing status, code and the result",
627
+ "schema": {
628
+ "title": "result",
629
+ "type": "object"
630
+ }
631
+ },
632
+ "roles": [
633
+ "admin"
634
+ ],
635
+ "route": {
636
+ "verb": "POST",
637
+ "path": "/getConfig"
638
+ },
639
+ "task": false
640
+ },
641
+ {
642
+ "name": "iapGetDeviceCount",
643
+ "summary": "Gets a device count from the system",
644
+ "description": "Gets a device count from the system",
645
+ "input": [],
646
+ "output": {
647
+ "name": "result",
648
+ "type": "object",
649
+ "description": "A JSON Object containing status, code and the result",
650
+ "schema": {
651
+ "title": "result",
652
+ "type": "object"
653
+ }
654
+ },
655
+ "roles": [
656
+ "admin"
657
+ ],
658
+ "route": {
659
+ "verb": "POST",
660
+ "path": "/iapGetDeviceCount"
661
+ },
662
+ "task": false
663
+ },
664
+ {
665
+ "name": "iapExpandedGenericAdapterRequest",
666
+ "summary": "Makes the requested generic call with additional options",
667
+ "description": "Makes the requested generic call with additional options via metadata",
668
+ "input": [
669
+ {
670
+ "name": "metadata",
671
+ "type": "object",
672
+ "info": "metadata for the call (optional)",
673
+ "description": "metadata for the call - allows for many enhancements (optional)",
674
+ "schema": {
675
+ "title": "metadata",
676
+ "type": "object"
677
+ },
678
+ "required": false
679
+ },
680
+ {
681
+ "name": "uriPath",
682
+ "type": "string",
683
+ "info": "the path of the api call - do not include the host, port, base path or version",
684
+ "description": "the path of the api call",
685
+ "schema": {
686
+ "title": "uriPath",
687
+ "type": "string"
688
+ },
689
+ "required": false
690
+ },
691
+ {
692
+ "name": "restMethod",
693
+ "type": "string",
694
+ "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
695
+ "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
696
+ "schema": {
697
+ "title": "restMethod",
698
+ "type": "string"
699
+ },
700
+ "required": false
701
+ },
702
+ {
703
+ "name": "pathVars",
704
+ "type": "object",
705
+ "info": "the parameters to be put within the url path (optional)",
706
+ "description": "the parameters to be put within the url path (optional)",
707
+ "schema": {
708
+ "title": "pathVars",
709
+ "type": "object"
710
+ },
711
+ "required": false
712
+ },
713
+ {
714
+ "name": "queryData",
715
+ "type": "object",
716
+ "info": "the query parameters to be put on the url (optional)",
717
+ "description": "the query parameters to be put on the url (optional)",
718
+ "schema": {
719
+ "title": "queryData",
720
+ "type": "object"
721
+ },
722
+ "required": false
723
+ },
724
+ {
725
+ "name": "requestBody",
726
+ "type": "object",
727
+ "info": "the payload to be sent with the request (optional)",
728
+ "description": "the payload to be sent with the request (optional)",
729
+ "schema": {
730
+ "title": "requestBody",
731
+ "type": "object"
732
+ },
733
+ "required": false
734
+ },
735
+ {
736
+ "name": "addlHeaders",
737
+ "type": "object",
738
+ "info": "additional headers to be put on the call (optional)",
739
+ "description": "additional headers to be put on the call (optional)",
740
+ "schema": {
741
+ "title": "addlHeaders",
742
+ "type": "object"
743
+ },
744
+ "required": false
745
+ }
746
+ ],
747
+ "output": {
748
+ "name": "result",
749
+ "type": "object",
750
+ "description": "A JSON Object containing status, code and the result",
751
+ "schema": {
752
+ "title": "result",
753
+ "type": "object"
754
+ }
755
+ },
756
+ "roles": [
757
+ "admin"
758
+ ],
759
+ "route": {
760
+ "verb": "POST",
761
+ "path": "/iapExpandedGenericAdapterRequest"
762
+ },
763
+ "task": true
764
+ },
765
+ {
766
+ "name": "genericAdapterRequest",
767
+ "summary": "Makes the requested generic call",
768
+ "description": "Makes the requested generic call",
769
+ "input": [
770
+ {
771
+ "name": "uriPath",
772
+ "type": "string",
773
+ "info": "the path of the api call - do not include the host, port, base path or version",
774
+ "description": "the path of the api call",
775
+ "schema": {
776
+ "title": "uriPath",
777
+ "type": "string"
778
+ },
779
+ "required": true
780
+ },
781
+ {
782
+ "name": "restMethod",
783
+ "type": "string",
784
+ "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
785
+ "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
786
+ "schema": {
787
+ "title": "restMethod",
788
+ "type": "string"
789
+ },
790
+ "required": true
791
+ },
792
+ {
793
+ "name": "queryData",
794
+ "type": "object",
795
+ "info": "the query parameters to be put on the url (optional)",
796
+ "description": "the query parameters to be put on the url (optional)",
797
+ "schema": {
798
+ "title": "queryData",
799
+ "type": "object"
800
+ },
801
+ "required": false
802
+ },
803
+ {
804
+ "name": "requestBody",
805
+ "type": "object",
806
+ "info": "the payload to be sent with the request (optional)",
807
+ "description": "the payload to be sent with the request (optional)",
808
+ "schema": {
809
+ "title": "requestBody",
810
+ "type": "object"
811
+ },
812
+ "required": false
813
+ },
814
+ {
815
+ "name": "addlHeaders",
816
+ "type": "object",
817
+ "info": "additional headers to be put on the call (optional)",
818
+ "description": "additional headers to be put on the call (optional)",
819
+ "schema": {
820
+ "title": "addlHeaders",
821
+ "type": "object"
822
+ },
823
+ "required": false
824
+ }
825
+ ],
826
+ "output": {
827
+ "name": "result",
828
+ "type": "object",
829
+ "description": "A JSON Object containing status, code and the result",
830
+ "schema": {
831
+ "title": "result",
832
+ "type": "object"
833
+ }
834
+ },
835
+ "roles": [
836
+ "admin"
837
+ ],
838
+ "route": {
839
+ "verb": "POST",
840
+ "path": "/genericAdapterRequest"
841
+ },
842
+ "task": true
843
+ },
844
+ {
845
+ "name": "genericAdapterRequestNoBasePath",
846
+ "summary": "Makes the requested generic call",
847
+ "description": "Makes the requested generic call",
848
+ "input": [
849
+ {
850
+ "name": "uriPath",
851
+ "type": "string",
852
+ "info": "the path of the api call - do not include the host, port, base path or version",
853
+ "description": "the path of the api call",
854
+ "schema": {
855
+ "title": "uriPath",
856
+ "type": "string"
857
+ },
858
+ "required": true
859
+ },
860
+ {
861
+ "name": "restMethod",
862
+ "type": "string",
863
+ "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
864
+ "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
865
+ "schema": {
866
+ "title": "restMethod",
867
+ "type": "string"
868
+ },
869
+ "required": true
870
+ },
871
+ {
872
+ "name": "queryData",
873
+ "type": "object",
874
+ "info": "the query parameters to be put on the url (optional)",
875
+ "description": "the query parameters to be put on the url (optional)",
876
+ "schema": {
877
+ "title": "queryData",
878
+ "type": "object"
879
+ },
880
+ "required": false
881
+ },
882
+ {
883
+ "name": "requestBody",
884
+ "type": "object",
885
+ "info": "the payload to be sent with the request (optional)",
886
+ "description": "the payload to be sent with the request (optional)",
887
+ "schema": {
888
+ "title": "requestBody",
889
+ "type": "object"
890
+ },
891
+ "required": false
892
+ },
893
+ {
894
+ "name": "addlHeaders",
895
+ "type": "object",
896
+ "info": "additional headers to be put on the call (optional)",
897
+ "description": "additional headers to be put on the call (optional)",
898
+ "schema": {
899
+ "title": "addlHeaders",
900
+ "type": "object"
901
+ },
902
+ "required": false
903
+ }
904
+ ],
905
+ "output": {
906
+ "name": "result",
907
+ "type": "object",
908
+ "description": "A JSON Object containing status, code and the result",
909
+ "schema": {
910
+ "title": "result",
911
+ "type": "object"
912
+ }
913
+ },
914
+ "roles": [
915
+ "admin"
916
+ ],
917
+ "route": {
918
+ "verb": "POST",
919
+ "path": "/genericAdapterRequestNoBasePath"
920
+ },
921
+ "task": true
922
+ },
923
+ {
924
+ "name": "iapRunAdapterLint",
925
+ "summary": "Run the adapter lint script to return the results",
926
+ "description": "Run the adapter lint script to return the results",
927
+ "input": [],
928
+ "output": {
929
+ "name": "result",
930
+ "type": "string",
931
+ "description": "A string containing the run results",
932
+ "schema": {
933
+ "title": "result",
934
+ "type": "string"
935
+ }
936
+ },
937
+ "roles": [
938
+ "admin"
939
+ ],
940
+ "route": {
941
+ "verb": "GET",
942
+ "path": "/iapRunAdapterLint"
943
+ },
944
+ "task": true
945
+ },
946
+ {
947
+ "name": "iapRunAdapterTests",
948
+ "summary": "Run the adapter test scripts (baseunit and unit) to return the results",
949
+ "description": "Run the adapter test scripts (baseunit and unit) to return the results",
950
+ "input": [],
951
+ "output": {
952
+ "name": "result",
953
+ "type": "object",
954
+ "description": "A JSON Object containing status, code and the result",
955
+ "schema": {
956
+ "title": "result",
957
+ "type": "object"
958
+ }
959
+ },
960
+ "roles": [
961
+ "admin"
962
+ ],
963
+ "route": {
964
+ "verb": "GET",
965
+ "path": "/iapRunAdapterTests"
966
+ },
967
+ "task": true
968
+ },
969
+ {
970
+ "name": "iapGetAdapterInventory",
971
+ "summary": "Provide inventory information abbout the adapter",
972
+ "description": "Provide inventory information abbout the adapter",
973
+ "input": [],
974
+ "output": {
975
+ "name": "result",
976
+ "type": "object",
977
+ "description": "A JSON Object containing status, code and the result",
978
+ "schema": {
979
+ "title": "result",
980
+ "type": "object"
981
+ }
982
+ },
983
+ "roles": [
984
+ "admin"
985
+ ],
986
+ "route": {
987
+ "verb": "GET",
988
+ "path": "/iapGetAdapterInventory"
989
+ },
990
+ "task": true
991
+ },
653
992
  {
654
993
  "name": "pipelinesCreate",
655
994
  "summary": "Create a pipeline.",