@itentialopensource/adapter-paragon_insights 0.1.2 → 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 (52) hide show
  1. package/.eslintignore +0 -1
  2. package/.jshintrc +3 -0
  3. package/CALLS.md +638 -483
  4. package/CHANGELOG.md +16 -0
  5. package/CONTRIBUTING.md +1 -160
  6. package/ENHANCE.md +2 -2
  7. package/README.md +31 -22
  8. package/adapter.js +10567 -8758
  9. package/adapterBase.js +538 -873
  10. package/changelogs/CHANGELOG.md +16 -0
  11. package/entities/Config/action.json +306 -0
  12. package/entities/Config/mockdatafiles/retrieveHealthbotIngestIfaDeviceIds-default.json +4 -0
  13. package/entities/Config/mockdatafiles/retrieveHealthbotIngestIfaDevices-default.json +10 -0
  14. package/entities/Config/schema.json +16 -1
  15. package/entities/Configuration/action.json +61 -0
  16. package/entities/Configuration/schema.json +4 -1
  17. package/entities/Utility/action.json +44 -0
  18. package/entities/Utility/schema.json +20 -0
  19. package/metadata.json +51 -0
  20. package/package.json +23 -25
  21. package/pronghorn.json +1480 -343
  22. package/propertiesSchema.json +453 -41
  23. package/refs?service=git-upload-pack +0 -0
  24. package/report/adapter-openapi.json +42358 -0
  25. package/report/adapter-openapi.yaml +29640 -0
  26. package/report/adapterInfo.json +8 -8
  27. package/report/updateReport1691508880430.json +120 -0
  28. package/report/updateReport1692202195666.json +120 -0
  29. package/report/updateReport1692203297401.json +120 -0
  30. package/report/updateReport1694469141676.json +120 -0
  31. package/report/updateReport1698422888699.json +120 -0
  32. package/sampleProperties.json +67 -14
  33. package/test/integration/adapterTestBasicGet.js +1 -1
  34. package/test/integration/adapterTestConnectivity.js +91 -42
  35. package/test/integration/adapterTestIntegration.js +640 -2
  36. package/test/unit/adapterBaseTestUnit.js +388 -315
  37. package/test/unit/adapterTestUnit.js +870 -110
  38. package/utils/adapterInfo.js +1 -1
  39. package/utils/addAuth.js +1 -1
  40. package/utils/artifactize.js +1 -1
  41. package/utils/checkMigrate.js +1 -1
  42. package/utils/entitiesToDB.js +1 -0
  43. package/utils/findPath.js +1 -1
  44. package/utils/methodDocumentor.js +71 -23
  45. package/utils/modify.js +13 -15
  46. package/utils/packModificationScript.js +1 -1
  47. package/utils/taskMover.js +309 -0
  48. package/utils/tbScript.js +3 -10
  49. package/utils/tbUtils.js +2 -3
  50. package/utils/testRunner.js +1 -1
  51. package/utils/troubleshootingAdapter.js +1 -3
  52. package/workflows/README.md +0 -3
package/pronghorn.json CHANGED
@@ -62,47 +62,22 @@
62
62
  "title": "action",
63
63
  "type": "string"
64
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": [
65
+ },
90
66
  {
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",
67
+ "name": "replace",
68
+ "type": "boolean",
69
+ "info": "True to replace entire mock data, false to merge/append",
70
+ "required": false,
95
71
  "schema": {
96
- "title": "apiPath",
97
- "type": "string"
98
- },
99
- "required": true
72
+ "title": "replace",
73
+ "type": "boolean"
74
+ }
100
75
  }
101
76
  ],
102
77
  "output": {
103
78
  "name": "result",
104
79
  "type": "object",
105
- "description": "A JSON Object containing the result",
80
+ "description": "A JSON Object containing status, code and the result",
106
81
  "schema": {
107
82
  "title": "result",
108
83
  "type": "object"
@@ -113,7 +88,7 @@
113
88
  ],
114
89
  "route": {
115
90
  "verb": "POST",
116
- "path": "/iapFindAdapterPath"
91
+ "path": "/iapUpdateAdapterConfiguration"
117
92
  },
118
93
  "task": true
119
94
  },
@@ -202,6 +177,41 @@
202
177
  },
203
178
  "task": true
204
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
+ },
205
215
  {
206
216
  "name": "iapTroubleshootAdapter",
207
217
  "summary": "Runs troubleshoot script for adapter",
@@ -221,7 +231,11 @@
221
231
  "name": "persistFlag",
222
232
  "type": "boolean",
223
233
  "info": "Whether the input properties should be saved",
224
- "required": true
234
+ "required": true,
235
+ "schema": {
236
+ "title": "persistFlag",
237
+ "type": "boolean"
238
+ }
225
239
  }
226
240
  ],
227
241
  "output": {
@@ -250,7 +264,11 @@
250
264
  "output": {
251
265
  "name": "result",
252
266
  "type": "boolean",
253
- "description": "Whether healthcheck passed or failed"
267
+ "description": "Whether healthcheck passed or failed",
268
+ "schema": {
269
+ "title": "result",
270
+ "type": "boolean"
271
+ }
254
272
  },
255
273
  "roles": [
256
274
  "admin"
@@ -331,64 +349,85 @@
331
349
  "task": true
332
350
  },
333
351
  {
334
- "name": "genericAdapterRequest",
335
- "summary": "Makes the requested generic call",
336
- "description": "Makes the requested generic call",
352
+ "name": "iapDeactivateTasks",
353
+ "summary": "Deactivate the inputted tasks",
354
+ "description": "Deactivate the inputted tasks",
337
355
  "input": [
338
356
  {
339
- "name": "uriPath",
340
- "type": "string",
341
- "info": "the path of the api call - do not include the host, port, base path or version",
342
- "description": "the path of the api call",
343
- "schema": {
344
- "title": "uriPath",
345
- "type": "string"
346
- },
347
- "required": true
348
- },
349
- {
350
- "name": "restMethod",
351
- "type": "string",
352
- "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
353
- "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
354
- "schema": {
355
- "title": "restMethod",
356
- "type": "string"
357
- },
358
- "required": true
359
- },
360
- {
361
- "name": "queryData",
362
- "type": "object",
363
- "info": "the query parameters to be put on the url (optional)",
364
- "description": "the query parameters to be put on the url (optional)",
357
+ "name": "tasks",
358
+ "type": "array",
359
+ "description": "Tasks to deactivate",
365
360
  "schema": {
366
- "title": "queryData",
367
- "type": "object"
368
- },
369
- "required": false
370
- },
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": [
371
389
  {
372
- "name": "requestBody",
373
- "type": "object",
374
- "info": "the payload to be sent with the request (optional)",
375
- "description": "the payload to be sent with the request (optional)",
390
+ "name": "tasks",
391
+ "type": "array",
392
+ "description": "Tasks to activate",
376
393
  "schema": {
377
- "title": "requestBody",
378
- "type": "object"
379
- },
380
- "required": false
381
- },
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": [
382
422
  {
383
- "name": "addlHeaders",
384
- "type": "object",
385
- "info": "additional headers to be put on the call (optional)",
386
- "description": "additional headers to be put on the call (optional)",
423
+ "name": "entityTypes",
424
+ "type": "array",
425
+ "info": "the entity type(s) to populate",
426
+ "required": true,
387
427
  "schema": {
388
- "title": "addlHeaders",
389
- "type": "object"
390
- },
391
- "required": false
428
+ "title": "entityTypes",
429
+ "type": "array"
430
+ }
392
431
  }
393
432
  ],
394
433
  "output": {
@@ -405,69 +444,34 @@
405
444
  ],
406
445
  "route": {
407
446
  "verb": "POST",
408
- "path": "/genericAdapterRequest"
447
+ "path": "/iapPopulateEntityCache"
409
448
  },
410
449
  "task": true
411
450
  },
412
451
  {
413
- "name": "genericAdapterRequestNoBasePath",
414
- "summary": "Makes the requested generic call",
415
- "description": "Makes the requested generic call",
452
+ "name": "iapRetrieveEntitiesCache",
453
+ "summary": "Retrieves data from cache for specified entity type",
454
+ "description": "Retrieves data from cache for specified entity type",
416
455
  "input": [
417
456
  {
418
- "name": "uriPath",
419
- "type": "string",
420
- "info": "the path of the api call - do not include the host, port, base path or version",
421
- "description": "the path of the api call",
422
- "schema": {
423
- "title": "uriPath",
424
- "type": "string"
425
- },
426
- "required": true
427
- },
428
- {
429
- "name": "restMethod",
457
+ "name": "entityType",
430
458
  "type": "string",
431
- "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
432
- "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
459
+ "info": "entity of which to retrieve",
460
+ "required": true,
433
461
  "schema": {
434
- "title": "restMethod",
462
+ "title": "entityType",
435
463
  "type": "string"
436
- },
437
- "required": true
438
- },
439
- {
440
- "name": "queryData",
441
- "type": "object",
442
- "info": "the query parameters to be put on the url (optional)",
443
- "description": "the query parameters to be put on the url (optional)",
444
- "schema": {
445
- "title": "queryData",
446
- "type": "object"
447
- },
448
- "required": false
449
- },
450
- {
451
- "name": "requestBody",
452
- "type": "object",
453
- "info": "the payload to be sent with the request (optional)",
454
- "description": "the payload to be sent with the request (optional)",
455
- "schema": {
456
- "title": "requestBody",
457
- "type": "object"
458
- },
459
- "required": false
464
+ }
460
465
  },
461
466
  {
462
- "name": "addlHeaders",
467
+ "name": "options",
463
468
  "type": "object",
464
- "info": "additional headers to be put on the call (optional)",
465
- "description": "additional headers to be put on the call (optional)",
469
+ "info": "settings of which data to return and how to return it",
470
+ "required": false,
466
471
  "schema": {
467
- "title": "addlHeaders",
472
+ "title": "options",
468
473
  "type": "object"
469
- },
470
- "required": false
474
+ }
471
475
  }
472
476
  ],
473
477
  "output": {
@@ -484,7 +488,7 @@
484
488
  ],
485
489
  "route": {
486
490
  "verb": "POST",
487
- "path": "/genericAdapterRequestNoBasePath"
491
+ "path": "/iapRetrieveEntitiesCache"
488
492
  },
489
493
  "task": true
490
494
  },
@@ -520,7 +524,7 @@
520
524
  "verb": "POST",
521
525
  "path": "/getDevice"
522
526
  },
523
- "task": true
527
+ "task": false
524
528
  },
525
529
  {
526
530
  "name": "getDevicesFiltered",
@@ -554,7 +558,7 @@
554
558
  "verb": "POST",
555
559
  "path": "/getDevicesFiltered"
556
560
  },
557
- "task": true
561
+ "task": false
558
562
  },
559
563
  {
560
564
  "name": "isAlive",
@@ -588,7 +592,7 @@
588
592
  "verb": "POST",
589
593
  "path": "/isAlive"
590
594
  },
591
- "task": true
595
+ "task": false
592
596
  },
593
597
  {
594
598
  "name": "getConfig",
@@ -632,7 +636,7 @@
632
636
  "verb": "POST",
633
637
  "path": "/getConfig"
634
638
  },
635
- "task": true
639
+ "task": false
636
640
  },
637
641
  {
638
642
  "name": "iapGetDeviceCount",
@@ -655,17 +659,95 @@
655
659
  "verb": "POST",
656
660
  "path": "/iapGetDeviceCount"
657
661
  },
658
- "task": true
662
+ "task": false
659
663
  },
660
664
  {
661
- "name": "retrieveOrchestrator",
662
- "summary": "retrieve_orchestrator",
663
- "description": "Get orchestrator type. Will be one of kubernetes or compose.",
664
- "input": [],
665
- "output": {
666
- "name": "result",
667
- "type": "object",
668
- "description": "A JSON Object containing status, code and the result",
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",
669
751
  "schema": {
670
752
  "title": "result",
671
753
  "type": "object"
@@ -675,25 +757,70 @@
675
757
  "admin"
676
758
  ],
677
759
  "route": {
678
- "verb": "GET",
679
- "path": "/retrieveOrchestrator"
760
+ "verb": "POST",
761
+ "path": "/iapExpandedGenericAdapterRequest"
680
762
  },
681
763
  "task": true
682
764
  },
683
765
  {
684
- "name": "rollbackUnsavedConfiguration",
685
- "summary": "rollback_unsaved_configuration",
686
- "description": "The API server follows a commit model. Unsaved configuration is called a working configuration. This API call deletes the working configuration.",
766
+ "name": "genericAdapterRequest",
767
+ "summary": "Makes the requested generic call",
768
+ "description": "Makes the requested generic call",
687
769
  "input": [
688
770
  {
689
- "name": "emsSanity",
690
- "type": "boolean",
691
- "info": "DEBUG (Use with caution): roll-back a faulty transaction in HB-EMS communication: boolean",
692
- "required": false,
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",
693
775
  "schema": {
694
- "title": "emsSanity",
695
- "type": "boolean"
696
- }
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
697
824
  }
698
825
  ],
699
826
  "output": {
@@ -710,15 +837,71 @@
710
837
  ],
711
838
  "route": {
712
839
  "verb": "POST",
713
- "path": "/rollbackUnsavedConfiguration"
840
+ "path": "/genericAdapterRequest"
714
841
  },
715
842
  "task": true
716
843
  },
717
844
  {
718
- "name": "retrieveAffectedGroups",
719
- "summary": "retrieve_affected_groups",
720
- "description": "Get all groups that are affected by the un-committed configuration changes.",
721
- "input": [],
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
+ ],
722
905
  "output": {
723
906
  "name": "result",
724
907
  "type": "object",
@@ -732,27 +915,39 @@
732
915
  "admin"
733
916
  ],
734
917
  "route": {
735
- "verb": "GET",
736
- "path": "/retrieveAffectedGroups"
918
+ "verb": "POST",
919
+ "path": "/genericAdapterRequestNoBasePath"
737
920
  },
738
921
  "task": true
739
922
  },
740
923
  {
741
- "name": "commitUnsavedConfiguration",
742
- "summary": "commit_unsaved_configuration",
743
- "description": "Commit the configuration in configuration database. Services of all the affected groups are started or restarted. If there is an error in the configuration, changes would not be saved into the database. If there is some system error, changes would be saved into the database.",
744
- "input": [
745
- {
746
- "name": "sync",
747
- "type": "boolean",
748
- "info": "Boolean variable is set to false allow the commit to go asynchronously, default value is true which means commit will go synchronously: boolean",
749
- "required": false,
750
- "schema": {
751
- "title": "sync",
752
- "type": "boolean"
753
- }
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"
754
935
  }
936
+ },
937
+ "roles": [
938
+ "admin"
755
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": [],
756
951
  "output": {
757
952
  "name": "result",
758
953
  "type": "object",
@@ -766,24 +961,161 @@
766
961
  "admin"
767
962
  ],
768
963
  "route": {
769
- "verb": "POST",
770
- "path": "/commitUnsavedConfiguration"
964
+ "verb": "GET",
965
+ "path": "/iapRunAdapterTests"
771
966
  },
772
967
  "task": true
773
968
  },
774
969
  {
775
- "name": "initialize",
776
- "summary": "initialize",
777
- "description": "Initialize config-server",
778
- "input": [
779
- {
780
- "name": "restartGroups",
781
- "type": "boolean",
782
- "info": "Boolean variable is set to true if group services have to be restarted. Defaults to true.: boolean",
783
- "required": false,
784
- "schema": {
785
- "title": "restartGroups",
786
- "type": "boolean"
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
+ },
992
+ {
993
+ "name": "retrieveOrchestrator",
994
+ "summary": "retrieve_orchestrator",
995
+ "description": "Get orchestrator type. Will be one of kubernetes or compose.",
996
+ "input": [],
997
+ "output": {
998
+ "name": "result",
999
+ "type": "object",
1000
+ "description": "A JSON Object containing status, code and the result",
1001
+ "schema": {
1002
+ "title": "result",
1003
+ "type": "object"
1004
+ }
1005
+ },
1006
+ "roles": [
1007
+ "admin"
1008
+ ],
1009
+ "route": {
1010
+ "verb": "GET",
1011
+ "path": "/retrieveOrchestrator"
1012
+ },
1013
+ "task": true
1014
+ },
1015
+ {
1016
+ "name": "rollbackUnsavedConfiguration",
1017
+ "summary": "rollback_unsaved_configuration",
1018
+ "description": "The API server follows a commit model. Unsaved configuration is called a working configuration. This API call deletes the working configuration.",
1019
+ "input": [
1020
+ {
1021
+ "name": "emsSanity",
1022
+ "type": "boolean",
1023
+ "info": "DEBUG (Use with caution): roll-back a faulty transaction in HB-EMS communication: boolean",
1024
+ "required": false,
1025
+ "schema": {
1026
+ "title": "emsSanity",
1027
+ "type": "boolean"
1028
+ }
1029
+ }
1030
+ ],
1031
+ "output": {
1032
+ "name": "result",
1033
+ "type": "object",
1034
+ "description": "A JSON Object containing status, code and the result",
1035
+ "schema": {
1036
+ "title": "result",
1037
+ "type": "object"
1038
+ }
1039
+ },
1040
+ "roles": [
1041
+ "admin"
1042
+ ],
1043
+ "route": {
1044
+ "verb": "POST",
1045
+ "path": "/rollbackUnsavedConfiguration"
1046
+ },
1047
+ "task": true
1048
+ },
1049
+ {
1050
+ "name": "retrieveAffectedGroups",
1051
+ "summary": "retrieve_affected_groups",
1052
+ "description": "Get all groups that are affected by the un-committed configuration changes.",
1053
+ "input": [],
1054
+ "output": {
1055
+ "name": "result",
1056
+ "type": "object",
1057
+ "description": "A JSON Object containing status, code and the result",
1058
+ "schema": {
1059
+ "title": "result",
1060
+ "type": "object"
1061
+ }
1062
+ },
1063
+ "roles": [
1064
+ "admin"
1065
+ ],
1066
+ "route": {
1067
+ "verb": "GET",
1068
+ "path": "/retrieveAffectedGroups"
1069
+ },
1070
+ "task": true
1071
+ },
1072
+ {
1073
+ "name": "commitUnsavedConfiguration",
1074
+ "summary": "commit_unsaved_configuration",
1075
+ "description": "Commit the configuration in configuration database. Services of all the affected groups are started or restarted. If there is an error in the configuration, changes would not be saved into the database. If there is some system error, changes would be saved into the database.",
1076
+ "input": [
1077
+ {
1078
+ "name": "sync",
1079
+ "type": "boolean",
1080
+ "info": "Boolean variable is set to false allow the commit to go asynchronously, default value is true which means commit will go synchronously: boolean",
1081
+ "required": false,
1082
+ "schema": {
1083
+ "title": "sync",
1084
+ "type": "boolean"
1085
+ }
1086
+ }
1087
+ ],
1088
+ "output": {
1089
+ "name": "result",
1090
+ "type": "object",
1091
+ "description": "A JSON Object containing status, code and the result",
1092
+ "schema": {
1093
+ "title": "result",
1094
+ "type": "object"
1095
+ }
1096
+ },
1097
+ "roles": [
1098
+ "admin"
1099
+ ],
1100
+ "route": {
1101
+ "verb": "POST",
1102
+ "path": "/commitUnsavedConfiguration"
1103
+ },
1104
+ "task": true
1105
+ },
1106
+ {
1107
+ "name": "initialize",
1108
+ "summary": "initialize",
1109
+ "description": "Initialize config-server",
1110
+ "input": [
1111
+ {
1112
+ "name": "restartGroups",
1113
+ "type": "boolean",
1114
+ "info": "Boolean variable is set to true if group services have to be restarted. Defaults to true.: boolean",
1115
+ "required": false,
1116
+ "schema": {
1117
+ "title": "restartGroups",
1118
+ "type": "boolean"
787
1119
  }
788
1120
  },
789
1121
  {
@@ -6344,7 +6676,7 @@
6344
6676
  {
6345
6677
  "name": "sort",
6346
6678
  "type": "enum",
6347
- "enumerals" : [
6679
+ "enumerals": [
6348
6680
  "asc",
6349
6681
  "desc"
6350
6682
  ],
@@ -20133,7 +20465,7 @@
20133
20465
  {
20134
20466
  "name": "color",
20135
20467
  "type": "enum",
20136
- "enumerals" : [
20468
+ "enumerals": [
20137
20469
  "all",
20138
20470
  "red",
20139
20471
  "yellow",
@@ -20257,7 +20589,7 @@
20257
20589
  {
20258
20590
  "name": "color",
20259
20591
  "type": "enum",
20260
- "enumerals" : [
20592
+ "enumerals": [
20261
20593
  "all",
20262
20594
  "red",
20263
20595
  "yellow",
@@ -20391,7 +20723,7 @@
20391
20723
  {
20392
20724
  "name": "color",
20393
20725
  "type": "enum",
20394
- "enumerals" : [
20726
+ "enumerals": [
20395
20727
  "all",
20396
20728
  "red",
20397
20729
  "yellow",
@@ -20505,7 +20837,7 @@
20505
20837
  {
20506
20838
  "name": "color",
20507
20839
  "type": "enum",
20508
- "enumerals" : [
20840
+ "enumerals": [
20509
20841
  "all",
20510
20842
  "red",
20511
20843
  "yellow",
@@ -20629,7 +20961,7 @@
20629
20961
  {
20630
20962
  "name": "color",
20631
20963
  "type": "enum",
20632
- "enumerals" : [
20964
+ "enumerals": [
20633
20965
  "all",
20634
20966
  "red",
20635
20967
  "yellow",
@@ -20763,7 +21095,7 @@
20763
21095
  {
20764
21096
  "name": "color",
20765
21097
  "type": "enum",
20766
- "enumerals" : [
21098
+ "enumerals": [
20767
21099
  "all",
20768
21100
  "red",
20769
21101
  "yellow",
@@ -20825,33 +21157,804 @@
20825
21157
  ],
20826
21158
  "route": {
20827
21159
  "verb": "POST",
20828
- "path": "/retrieveEventByEventName"
21160
+ "path": "/retrieveEventByEventName"
21161
+ },
21162
+ "task": true
21163
+ },
21164
+ {
21165
+ "name": "getFieldsFromXpath",
21166
+ "summary": "get_fields_from_xpath",
21167
+ "description": "Get the values of all fields",
21168
+ "input": [
21169
+ {
21170
+ "name": "xpath",
21171
+ "type": "string",
21172
+ "info": "XPATH: string",
21173
+ "required": true,
21174
+ "schema": {
21175
+ "title": "xpath",
21176
+ "type": "string"
21177
+ }
21178
+ },
21179
+ {
21180
+ "name": "timestamp",
21181
+ "type": "string",
21182
+ "info": "Timestamp: string",
21183
+ "required": false,
21184
+ "schema": {
21185
+ "title": "timestamp",
21186
+ "type": "string"
21187
+ }
21188
+ }
21189
+ ],
21190
+ "output": {
21191
+ "name": "result",
21192
+ "type": "object",
21193
+ "description": "A JSON Object containing status, code and the result",
21194
+ "schema": {
21195
+ "title": "result",
21196
+ "type": "object"
21197
+ }
21198
+ },
21199
+ "roles": [
21200
+ "admin"
21201
+ ],
21202
+ "route": {
21203
+ "verb": "POST",
21204
+ "path": "/getFieldsFromXpath"
21205
+ },
21206
+ "task": true
21207
+ },
21208
+ {
21209
+ "name": "restoreGrafana",
21210
+ "summary": "restore_grafana",
21211
+ "description": "Restore Grafana configuration",
21212
+ "input": [
21213
+ {
21214
+ "name": "restoreFile",
21215
+ "type": "string",
21216
+ "info": "File content: string",
21217
+ "required": true,
21218
+ "schema": {
21219
+ "title": "restoreFile",
21220
+ "type": "string"
21221
+ }
21222
+ }
21223
+ ],
21224
+ "output": {
21225
+ "name": "result",
21226
+ "type": "object",
21227
+ "description": "A JSON Object containing status, code and the result",
21228
+ "schema": {
21229
+ "title": "result",
21230
+ "type": "object"
21231
+ }
21232
+ },
21233
+ "roles": [
21234
+ "admin"
21235
+ ],
21236
+ "route": {
21237
+ "verb": "POST",
21238
+ "path": "/restoreGrafana"
21239
+ },
21240
+ "task": true
21241
+ },
21242
+ {
21243
+ "name": "backupGrafana",
21244
+ "summary": "backup_grafana",
21245
+ "description": "Take backup of Grafana configuration",
21246
+ "input": [],
21247
+ "output": {
21248
+ "name": "result",
21249
+ "type": "object",
21250
+ "description": "A JSON Object containing status, code and the result",
21251
+ "schema": {
21252
+ "title": "result",
21253
+ "type": "object"
21254
+ }
21255
+ },
21256
+ "roles": [
21257
+ "admin"
21258
+ ],
21259
+ "route": {
21260
+ "verb": "GET",
21261
+ "path": "/backupGrafana"
21262
+ },
21263
+ "task": true
21264
+ },
21265
+ {
21266
+ "name": "getGrafanaLogin",
21267
+ "summary": "grafana_login",
21268
+ "description": "Login to Grafana",
21269
+ "input": [],
21270
+ "output": {
21271
+ "name": "result",
21272
+ "type": "object",
21273
+ "description": "A JSON Object containing status, code and the result",
21274
+ "schema": {
21275
+ "title": "result",
21276
+ "type": "object"
21277
+ }
21278
+ },
21279
+ "roles": [
21280
+ "admin"
21281
+ ],
21282
+ "route": {
21283
+ "verb": "GET",
21284
+ "path": "/getGrafanaLogin"
21285
+ },
21286
+ "task": true
21287
+ },
21288
+ {
21289
+ "name": "retrieveHealthTreeByDeviceGroup",
21290
+ "summary": "retrieve_health_tree_by_device_group",
21291
+ "description": "Get health-tree of a specified device-group.",
21292
+ "input": [
21293
+ {
21294
+ "name": "deviceGroupName",
21295
+ "type": "string",
21296
+ "info": "`device-group-name` of device-group: string",
21297
+ "required": true,
21298
+ "schema": {
21299
+ "title": "deviceGroupName",
21300
+ "type": "string"
21301
+ }
21302
+ },
21303
+ {
21304
+ "name": "timestamp",
21305
+ "type": "string",
21306
+ "info": "Timestamp at which health tree is requested. If not specified, current server timestamp is used.: string",
21307
+ "required": false,
21308
+ "schema": {
21309
+ "title": "timestamp",
21310
+ "type": "string"
21311
+ }
21312
+ },
21313
+ {
21314
+ "name": "tolerance",
21315
+ "type": "number",
21316
+ "info": "Timestamp tolerance in seconds. With this option, health-tree will contain latest data between `timestamp-2*tolerance` and `timestamp`. Default value is `2*frequency` whe...(description truncated): 123",
21317
+ "required": false,
21318
+ "schema": {
21319
+ "title": "tolerance",
21320
+ "type": "number"
21321
+ }
21322
+ },
21323
+ {
21324
+ "name": "device",
21325
+ "type": "array",
21326
+ "info": "list of devices under a device-group to be fetched: array",
21327
+ "required": false,
21328
+ "schema": {
21329
+ "title": "device",
21330
+ "type": "array"
21331
+ }
21332
+ }
21333
+ ],
21334
+ "output": {
21335
+ "name": "result",
21336
+ "type": "object",
21337
+ "description": "A JSON Object containing status, code and the result",
21338
+ "schema": {
21339
+ "title": "result",
21340
+ "type": "object"
21341
+ }
21342
+ },
21343
+ "roles": [
21344
+ "admin"
21345
+ ],
21346
+ "route": {
21347
+ "verb": "POST",
21348
+ "path": "/retrieveHealthTreeByDeviceGroup"
21349
+ },
21350
+ "task": true
21351
+ },
21352
+ {
21353
+ "name": "retrieveHealthTreeByNetworkGroup",
21354
+ "summary": "retrieve_health_tree_by_network_group",
21355
+ "description": "Get health-tree of a specified network-group.",
21356
+ "input": [
21357
+ {
21358
+ "name": "networkGroupName",
21359
+ "type": "string",
21360
+ "info": "`network-group-name` of network-group: string",
21361
+ "required": true,
21362
+ "schema": {
21363
+ "title": "networkGroupName",
21364
+ "type": "string"
21365
+ }
21366
+ },
21367
+ {
21368
+ "name": "timestamp",
21369
+ "type": "string",
21370
+ "info": "Timestamp at which health tree is requested. If not specified, current server timestamp is used.: string",
21371
+ "required": false,
21372
+ "schema": {
21373
+ "title": "timestamp",
21374
+ "type": "string"
21375
+ }
21376
+ },
21377
+ {
21378
+ "name": "tolerance",
21379
+ "type": "number",
21380
+ "info": "Timestamp tolerance in seconds. With this option, health-tree will contain latest data between `timestamp-2*tolerance` and `timestamp`. Default value is `2*frequency` whe...(description truncated): 123",
21381
+ "required": false,
21382
+ "schema": {
21383
+ "title": "tolerance",
21384
+ "type": "number"
21385
+ }
21386
+ }
21387
+ ],
21388
+ "output": {
21389
+ "name": "result",
21390
+ "type": "object",
21391
+ "description": "A JSON Object containing status, code and the result",
21392
+ "schema": {
21393
+ "title": "result",
21394
+ "type": "object"
21395
+ }
21396
+ },
21397
+ "roles": [
21398
+ "admin"
21399
+ ],
21400
+ "route": {
21401
+ "verb": "POST",
21402
+ "path": "/retrieveHealthTreeByNetworkGroup"
21403
+ },
21404
+ "task": true
21405
+ },
21406
+ {
21407
+ "name": "retrieveHealthTreeById",
21408
+ "summary": "retrieve_health_tree_by_id",
21409
+ "description": "Return health-tree of a specified device identified by `device-id`.",
21410
+ "input": [
21411
+ {
21412
+ "name": "deviceId",
21413
+ "type": "string",
21414
+ "info": "`device-id` of device: string",
21415
+ "required": true,
21416
+ "schema": {
21417
+ "title": "deviceId",
21418
+ "type": "string"
21419
+ }
21420
+ },
21421
+ {
21422
+ "name": "timestamp",
21423
+ "type": "string",
21424
+ "info": "Timestamp at which health tree is requested. If not specified, current server timestamp is used.: string",
21425
+ "required": false,
21426
+ "schema": {
21427
+ "title": "timestamp",
21428
+ "type": "string"
21429
+ }
21430
+ },
21431
+ {
21432
+ "name": "tolerance",
21433
+ "type": "number",
21434
+ "info": "Timestamp tolerance in seconds. With this option, health-tree will contain latest data between `timestamp-2*tolerance` and `timestamp`. Default value is `2*frequency` whe...(description truncated): 123",
21435
+ "required": false,
21436
+ "schema": {
21437
+ "title": "tolerance",
21438
+ "type": "number"
21439
+ }
21440
+ }
21441
+ ],
21442
+ "output": {
21443
+ "name": "result",
21444
+ "type": "object",
21445
+ "description": "A JSON Object containing status, code and the result",
21446
+ "schema": {
21447
+ "title": "result",
21448
+ "type": "object"
21449
+ }
21450
+ },
21451
+ "roles": [
21452
+ "admin"
21453
+ ],
21454
+ "route": {
21455
+ "verb": "POST",
21456
+ "path": "/retrieveHealthTreeById"
21457
+ },
21458
+ "task": true
21459
+ },
21460
+ {
21461
+ "name": "retrieveHealthAll",
21462
+ "summary": "retrieve_health_all",
21463
+ "description": "Returns health of network-groups and devices in device-groups",
21464
+ "input": [],
21465
+ "output": {
21466
+ "name": "result",
21467
+ "type": "object",
21468
+ "description": "A JSON Object containing status, code and the result",
21469
+ "schema": {
21470
+ "title": "result",
21471
+ "type": "object"
21472
+ }
21473
+ },
21474
+ "roles": [
21475
+ "admin"
21476
+ ],
21477
+ "route": {
21478
+ "verb": "GET",
21479
+ "path": "/retrieveHealthAll"
21480
+ },
21481
+ "task": true
21482
+ },
21483
+ {
21484
+ "name": "postInspectCommandRpcTable",
21485
+ "summary": "inspect_command_rpc_table_on_device",
21486
+ "description": "Inspect the given iAgent table on a device and return the results.",
21487
+ "input": [
21488
+ {
21489
+ "name": "body",
21490
+ "type": "object",
21491
+ "info": "command-rpc object: object",
21492
+ "required": true,
21493
+ "schema": {
21494
+ "allOf": [
21495
+ {
21496
+ "type": "object"
21497
+ },
21498
+ {
21499
+ "description": "command-rpc object"
21500
+ }
21501
+ ],
21502
+ "definitions": {}
21503
+ }
21504
+ }
21505
+ ],
21506
+ "output": {
21507
+ "name": "result",
21508
+ "type": "object",
21509
+ "description": "A JSON Object containing status, code and the result",
21510
+ "schema": {
21511
+ "title": "result",
21512
+ "type": "object"
21513
+ }
21514
+ },
21515
+ "roles": [
21516
+ "admin"
21517
+ ],
21518
+ "route": {
21519
+ "verb": "POST",
21520
+ "path": "/postInspectCommandRpcTable"
21521
+ },
21522
+ "task": true
21523
+ },
21524
+ {
21525
+ "name": "retrieveDeviceTriggerInfo",
21526
+ "summary": "retrieve_device_trigger_info",
21527
+ "description": "Get information about the triggers in device-groups having the provided device.",
21528
+ "input": [
21529
+ {
21530
+ "name": "deviceId",
21531
+ "type": "string",
21532
+ "info": "Name of device: string",
21533
+ "required": true,
21534
+ "schema": {
21535
+ "title": "deviceId",
21536
+ "type": "string"
21537
+ }
21538
+ }
21539
+ ],
21540
+ "output": {
21541
+ "name": "result",
21542
+ "type": "object",
21543
+ "description": "A JSON Object containing status, code and the result",
21544
+ "schema": {
21545
+ "title": "result",
21546
+ "type": "object"
21547
+ }
21548
+ },
21549
+ "roles": [
21550
+ "admin"
21551
+ ],
21552
+ "route": {
21553
+ "verb": "POST",
21554
+ "path": "/retrieveDeviceTriggerInfo"
21555
+ },
21556
+ "task": true
21557
+ },
21558
+ {
21559
+ "name": "removeIcebergDevicesFromGroup",
21560
+ "summary": "remove_iceberg_devices_from_group",
21561
+ "description": "Remove the list of devices from the device group",
21562
+ "input": [
21563
+ {
21564
+ "name": "deviceGroupName",
21565
+ "type": "string",
21566
+ "info": "ID of group: string",
21567
+ "required": true,
21568
+ "schema": {
21569
+ "title": "deviceGroupName",
21570
+ "type": "string"
21571
+ }
21572
+ }
21573
+ ],
21574
+ "output": {
21575
+ "name": "result",
21576
+ "type": "object",
21577
+ "description": "A JSON Object containing status, code and the result",
21578
+ "schema": {
21579
+ "title": "result",
21580
+ "type": "object"
21581
+ }
21582
+ },
21583
+ "roles": [
21584
+ "admin"
21585
+ ],
21586
+ "route": {
21587
+ "verb": "POST",
21588
+ "path": "/removeIcebergDevicesFromGroup"
21589
+ },
21590
+ "task": true
21591
+ },
21592
+ {
21593
+ "name": "removeIcebergNetworkGroupNetworkGroupById",
21594
+ "summary": "remove_iceberg_network_group_network_group_by_id",
21595
+ "description": "Overwrite a network-group by the `network-group-name`. The `network-group-name` specified in the URL and the request body must match.",
21596
+ "input": [
21597
+ {
21598
+ "name": "networkGroupName",
21599
+ "type": "string",
21600
+ "info": "ID of network-group-name: string",
21601
+ "required": true,
21602
+ "schema": {
21603
+ "title": "networkGroupName",
21604
+ "type": "string"
21605
+ }
21606
+ }
21607
+ ],
21608
+ "output": {
21609
+ "name": "result",
21610
+ "type": "object",
21611
+ "description": "A JSON Object containing status, code and the result",
21612
+ "schema": {
21613
+ "title": "result",
21614
+ "type": "object"
21615
+ }
21616
+ },
21617
+ "roles": [
21618
+ "admin"
21619
+ ],
21620
+ "route": {
21621
+ "verb": "POST",
21622
+ "path": "/removeIcebergNetworkGroupNetworkGroupById"
21623
+ },
21624
+ "task": true
21625
+ },
21626
+ {
21627
+ "name": "retrieveHealthbotIngestSettingsPaa",
21628
+ "summary": "retrieve_healthbot_ingest_settings_paa",
21629
+ "description": "Retrieve operation of resource: paa",
21630
+ "input": [
21631
+ {
21632
+ "name": "working",
21633
+ "type": "boolean",
21634
+ "info": "true queries undeployed configuration: boolean",
21635
+ "required": false,
21636
+ "schema": {
21637
+ "title": "working",
21638
+ "type": "boolean"
21639
+ }
21640
+ }
21641
+ ],
21642
+ "output": {
21643
+ "name": "result",
21644
+ "type": "object",
21645
+ "description": "A JSON Object containing status, code and the result",
21646
+ "schema": {
21647
+ "title": "result",
21648
+ "type": "object"
21649
+ }
21650
+ },
21651
+ "roles": [
21652
+ "admin"
21653
+ ],
21654
+ "route": {
21655
+ "verb": "POST",
21656
+ "path": "/retrieveHealthbotIngestSettingsPaa"
21657
+ },
21658
+ "task": true
21659
+ },
21660
+ {
21661
+ "name": "deleteHealthbotIngestPaaByPaaName",
21662
+ "summary": "delete_healthbot_ingest_paa_by_paa_name",
21663
+ "description": "Delete operation of resource: paa by paa name",
21664
+ "input": [
21665
+ {
21666
+ "name": "paaName",
21667
+ "type": "string",
21668
+ "info": "name of paa setup: string",
21669
+ "required": true,
21670
+ "schema": {
21671
+ "title": "paaName",
21672
+ "type": "string"
21673
+ }
21674
+ }
21675
+ ],
21676
+ "output": {
21677
+ "name": "result",
21678
+ "type": "object",
21679
+ "description": "A JSON Object containing status, code and the result",
21680
+ "schema": {
21681
+ "title": "result",
21682
+ "type": "object"
21683
+ }
21684
+ },
21685
+ "roles": [
21686
+ "admin"
21687
+ ],
21688
+ "route": {
21689
+ "verb": "POST",
21690
+ "path": "/deleteHealthbotIngestPaaByPaaName"
21691
+ },
21692
+ "task": true
21693
+ },
21694
+ {
21695
+ "name": "retrieveHealthbotIngestPaaByPaaName",
21696
+ "summary": "retrieve_healthbot_ingest_paa_by_paa_name",
21697
+ "description": "Retrieve operation of resource: paa by paa_name",
21698
+ "input": [
21699
+ {
21700
+ "name": "paaName",
21701
+ "type": "string",
21702
+ "info": "name of paa setup: string",
21703
+ "required": true,
21704
+ "schema": {
21705
+ "title": "paaName",
21706
+ "type": "string"
21707
+ }
21708
+ },
21709
+ {
21710
+ "name": "working",
21711
+ "type": "boolean",
21712
+ "info": "true queries undeployed configuration: boolean",
21713
+ "required": false,
21714
+ "schema": {
21715
+ "title": "working",
21716
+ "type": "boolean"
21717
+ }
21718
+ }
21719
+ ],
21720
+ "output": {
21721
+ "name": "result",
21722
+ "type": "object",
21723
+ "description": "A JSON Object containing status, code and the result",
21724
+ "schema": {
21725
+ "title": "result",
21726
+ "type": "object"
21727
+ }
21728
+ },
21729
+ "roles": [
21730
+ "admin"
21731
+ ],
21732
+ "route": {
21733
+ "verb": "POST",
21734
+ "path": "/retrieveHealthbotIngestPaaByPaaName"
21735
+ },
21736
+ "task": true
21737
+ },
21738
+ {
21739
+ "name": "updateIngestPaaByPaaName",
21740
+ "summary": "update_ingest_paa_by_paa_name",
21741
+ "description": "Update operation of resource: paa by paa_name",
21742
+ "input": [
21743
+ {
21744
+ "name": "paaName",
21745
+ "type": "string",
21746
+ "info": "name of paa setup: string",
21747
+ "required": true,
21748
+ "schema": {
21749
+ "title": "paaName",
21750
+ "type": "string"
21751
+ }
21752
+ },
21753
+ {
21754
+ "name": "body",
21755
+ "type": "object",
21756
+ "info": "paa body object: object",
21757
+ "required": true,
21758
+ "schema": {
21759
+ "allOf": [
21760
+ {
21761
+ "type": "object"
21762
+ },
21763
+ {
21764
+ "description": "paa body object"
21765
+ }
21766
+ ],
21767
+ "definitions": {}
21768
+ }
21769
+ }
21770
+ ],
21771
+ "output": {
21772
+ "name": "result",
21773
+ "type": "object",
21774
+ "description": "A JSON Object containing status, code and the result",
21775
+ "schema": {
21776
+ "title": "result",
21777
+ "type": "object"
21778
+ }
21779
+ },
21780
+ "roles": [
21781
+ "admin"
21782
+ ],
21783
+ "route": {
21784
+ "verb": "POST",
21785
+ "path": "/updateIngestPaaByPaaName"
21786
+ },
21787
+ "task": true
21788
+ },
21789
+ {
21790
+ "name": "createIngestPaaByPaaName",
21791
+ "summary": "create_ingest_paa_by_paa_name",
21792
+ "description": "Create operation of resource: paa by paa_name",
21793
+ "input": [
21794
+ {
21795
+ "name": "paaName",
21796
+ "type": "string",
21797
+ "info": "name of paa setup: string",
21798
+ "required": true,
21799
+ "schema": {
21800
+ "title": "paaName",
21801
+ "type": "string"
21802
+ }
21803
+ },
21804
+ {
21805
+ "name": "body",
21806
+ "type": "object",
21807
+ "info": "paa body object: object",
21808
+ "required": true,
21809
+ "schema": {
21810
+ "allOf": [
21811
+ {
21812
+ "type": "object"
21813
+ },
21814
+ {
21815
+ "description": "paa body object"
21816
+ }
21817
+ ],
21818
+ "definitions": {}
21819
+ }
21820
+ }
21821
+ ],
21822
+ "output": {
21823
+ "name": "result",
21824
+ "type": "object",
21825
+ "description": "A JSON Object containing status, code and the result",
21826
+ "schema": {
21827
+ "title": "result",
21828
+ "type": "object"
21829
+ }
21830
+ },
21831
+ "roles": [
21832
+ "admin"
21833
+ ],
21834
+ "route": {
21835
+ "verb": "POST",
21836
+ "path": "/createIngestPaaByPaaName"
21837
+ },
21838
+ "task": true
21839
+ },
21840
+ {
21841
+ "name": "deleteHealthbotIngestIfa",
21842
+ "summary": "delete_healthbot_ingest_ifa",
21843
+ "description": "Delete operation of resource: ifa",
21844
+ "input": [],
21845
+ "output": {
21846
+ "name": "result",
21847
+ "type": "object",
21848
+ "description": "A JSON Object containing status, code and the result",
21849
+ "schema": {
21850
+ "title": "result",
21851
+ "type": "object"
21852
+ }
21853
+ },
21854
+ "roles": [
21855
+ "admin"
21856
+ ],
21857
+ "route": {
21858
+ "verb": "GET",
21859
+ "path": "/deleteHealthbotIngestIfa"
21860
+ },
21861
+ "task": true
21862
+ },
21863
+ {
21864
+ "name": "retrieveHealthbotIngestIfa",
21865
+ "summary": "retrieve_healthbot_ingest_ifa",
21866
+ "description": "Retrieve operation of resource: ifa",
21867
+ "input": [
21868
+ {
21869
+ "name": "working",
21870
+ "type": "boolean",
21871
+ "info": "true queries undeployed configuration: boolean",
21872
+ "required": false,
21873
+ "schema": {
21874
+ "title": "working",
21875
+ "type": "boolean"
21876
+ }
21877
+ }
21878
+ ],
21879
+ "output": {
21880
+ "name": "result",
21881
+ "type": "object",
21882
+ "description": "A JSON Object containing status, code and the result",
21883
+ "schema": {
21884
+ "title": "result",
21885
+ "type": "object"
21886
+ }
21887
+ },
21888
+ "roles": [
21889
+ "admin"
21890
+ ],
21891
+ "route": {
21892
+ "verb": "POST",
21893
+ "path": "/retrieveHealthbotIngestIfa"
21894
+ },
21895
+ "task": true
21896
+ },
21897
+ {
21898
+ "name": "createHealthbotIngestIfa",
21899
+ "summary": "create_healthbot_ingest_ifa",
21900
+ "description": "Create operation of resource: ifa",
21901
+ "input": [
21902
+ {
21903
+ "name": "body",
21904
+ "type": "object",
21905
+ "info": "ifabody object: object",
21906
+ "required": true,
21907
+ "schema": {
21908
+ "allOf": [
21909
+ {
21910
+ "type": "object"
21911
+ },
21912
+ {
21913
+ "description": "ifabody object"
21914
+ }
21915
+ ],
21916
+ "definitions": {}
21917
+ }
21918
+ }
21919
+ ],
21920
+ "output": {
21921
+ "name": "result",
21922
+ "type": "object",
21923
+ "description": "A JSON Object containing status, code and the result",
21924
+ "schema": {
21925
+ "title": "result",
21926
+ "type": "object"
21927
+ }
21928
+ },
21929
+ "roles": [
21930
+ "admin"
21931
+ ],
21932
+ "route": {
21933
+ "verb": "POST",
21934
+ "path": "/createHealthbotIngestIfa"
20829
21935
  },
20830
21936
  "task": true
20831
21937
  },
20832
21938
  {
20833
- "name": "getFieldsFromXpath",
20834
- "summary": "get_fields_from_xpath",
20835
- "description": "Get the values of all fields",
21939
+ "name": "updateHealthbotIngestIfa",
21940
+ "summary": "update_healthbot_ingest_ifa",
21941
+ "description": "Update operation of resource: ifa",
20836
21942
  "input": [
20837
21943
  {
20838
- "name": "xpath",
20839
- "type": "string",
20840
- "info": "XPATH: string",
21944
+ "name": "body",
21945
+ "type": "object",
21946
+ "info": "ifabody object: object",
20841
21947
  "required": true,
20842
21948
  "schema": {
20843
- "title": "xpath",
20844
- "type": "string"
20845
- }
20846
- },
20847
- {
20848
- "name": "timestamp",
20849
- "type": "string",
20850
- "info": "Timestamp: string",
20851
- "required": false,
20852
- "schema": {
20853
- "title": "timestamp",
20854
- "type": "string"
21949
+ "allOf": [
21950
+ {
21951
+ "type": "object"
21952
+ },
21953
+ {
21954
+ "description": "ifabody object"
21955
+ }
21956
+ ],
21957
+ "definitions": {}
20855
21958
  }
20856
21959
  }
20857
21960
  ],
@@ -20869,23 +21972,23 @@
20869
21972
  ],
20870
21973
  "route": {
20871
21974
  "verb": "POST",
20872
- "path": "/getFieldsFromXpath"
21975
+ "path": "/updateHealthbotIngestIfa"
20873
21976
  },
20874
21977
  "task": true
20875
21978
  },
20876
21979
  {
20877
- "name": "restoreGrafana",
20878
- "summary": "restore_grafana",
20879
- "description": "Restore Grafana configuration",
21980
+ "name": "retrieveHealthbotIngestIfaDeviceIds",
21981
+ "summary": "retrieve_healthbot_ingest_ifa_device_ids",
21982
+ "description": "Retrieve operation of resource: device",
20880
21983
  "input": [
20881
21984
  {
20882
- "name": "restoreFile",
20883
- "type": "string",
20884
- "info": "File content: string",
20885
- "required": true,
21985
+ "name": "working",
21986
+ "type": "boolean",
21987
+ "info": "true queries undeployed configuration: boolean",
21988
+ "required": false,
20886
21989
  "schema": {
20887
- "title": "restoreFile",
20888
- "type": "string"
21990
+ "title": "working",
21991
+ "type": "boolean"
20889
21992
  }
20890
21993
  }
20891
21994
  ],
@@ -20894,8 +21997,11 @@
20894
21997
  "type": "object",
20895
21998
  "description": "A JSON Object containing status, code and the result",
20896
21999
  "schema": {
20897
- "title": "result",
20898
- "type": "object"
22000
+ "type": "array",
22001
+ "items": {
22002
+ "type": "string"
22003
+ },
22004
+ "description": ""
20899
22005
  }
20900
22006
  },
20901
22007
  "roles": [
@@ -20903,38 +22009,77 @@
20903
22009
  ],
20904
22010
  "route": {
20905
22011
  "verb": "POST",
20906
- "path": "/restoreGrafana"
22012
+ "path": "/retrieveHealthbotIngestIfaDeviceIds"
20907
22013
  },
20908
22014
  "task": true
20909
22015
  },
20910
22016
  {
20911
- "name": "backupGrafana",
20912
- "summary": "backup_grafana",
20913
- "description": "Take backup of Grafana configuration",
20914
- "input": [],
22017
+ "name": "retrieveHealthbotIngestIfaDevices",
22018
+ "summary": "retrieve_healthbot_ingest_ifa_devices",
22019
+ "description": "Retrieve operation of resource: device",
22020
+ "input": [
22021
+ {
22022
+ "name": "working",
22023
+ "type": "boolean",
22024
+ "info": "true queries undeployed configuration: boolean",
22025
+ "required": false,
22026
+ "schema": {
22027
+ "title": "working",
22028
+ "type": "boolean"
22029
+ }
22030
+ }
22031
+ ],
20915
22032
  "output": {
20916
22033
  "name": "result",
20917
22034
  "type": "object",
20918
22035
  "description": "A JSON Object containing status, code and the result",
20919
22036
  "schema": {
20920
- "title": "result",
20921
- "type": "object"
22037
+ "type": "array",
22038
+ "items": {
22039
+ "title": "ifa_device_schema",
22040
+ "required": [
22041
+ "id"
22042
+ ],
22043
+ "type": "object",
22044
+ "properties": {
22045
+ "id": {
22046
+ "type": "integer",
22047
+ "description": "Device number"
22048
+ },
22049
+ "name": {
22050
+ "type": "string",
22051
+ "description": "Device name"
22052
+ }
22053
+ }
22054
+ },
22055
+ "description": ""
20922
22056
  }
20923
22057
  },
20924
22058
  "roles": [
20925
22059
  "admin"
20926
22060
  ],
20927
22061
  "route": {
20928
- "verb": "GET",
20929
- "path": "/backupGrafana"
22062
+ "verb": "POST",
22063
+ "path": "/retrieveHealthbotIngestIfaDevices"
20930
22064
  },
20931
22065
  "task": true
20932
22066
  },
20933
22067
  {
20934
- "name": "getGrafanaLogin",
20935
- "summary": "grafana_login",
20936
- "description": "Login to Grafana",
20937
- "input": [],
22068
+ "name": "deleteHealthbotIngestIfaDeviceById",
22069
+ "summary": "delete_healthbot_ingest_ifa_device_by_id",
22070
+ "description": "Delete operation of resource: device",
22071
+ "input": [
22072
+ {
22073
+ "name": "id",
22074
+ "type": "number",
22075
+ "info": "ID of ifa device: 123",
22076
+ "required": true,
22077
+ "schema": {
22078
+ "title": "id",
22079
+ "type": "number"
22080
+ }
22081
+ }
22082
+ ],
20938
22083
  "output": {
20939
22084
  "name": "result",
20940
22085
  "type": "object",
@@ -20948,54 +22093,34 @@
20948
22093
  "admin"
20949
22094
  ],
20950
22095
  "route": {
20951
- "verb": "GET",
20952
- "path": "/getGrafanaLogin"
22096
+ "verb": "POST",
22097
+ "path": "/deleteHealthbotIngestIfaDeviceById"
20953
22098
  },
20954
22099
  "task": true
20955
22100
  },
20956
22101
  {
20957
- "name": "retrieveHealthTreeByDeviceGroup",
20958
- "summary": "retrieve_health_tree_by_device_group",
20959
- "description": "Get health-tree of a specified device-group.",
22102
+ "name": "retrieveHealthbotIngestIfaDeviceById",
22103
+ "summary": "retrieve_healthbot_ingest_ifa_device_by_id",
22104
+ "description": "Retrieve operation of resource: device",
20960
22105
  "input": [
20961
22106
  {
20962
- "name": "deviceGroupName",
20963
- "type": "string",
20964
- "info": "`device-group-name` of device-group: string",
20965
- "required": true,
20966
- "schema": {
20967
- "title": "deviceGroupName",
20968
- "type": "string"
20969
- }
20970
- },
20971
- {
20972
- "name": "timestamp",
20973
- "type": "string",
20974
- "info": "Timestamp at which health tree is requested. If not specified, current server timestamp is used.: string",
20975
- "required": false,
20976
- "schema": {
20977
- "title": "timestamp",
20978
- "type": "string"
20979
- }
20980
- },
20981
- {
20982
- "name": "tolerance",
22107
+ "name": "id",
20983
22108
  "type": "number",
20984
- "info": "Timestamp tolerance in seconds. With this option, health-tree will contain latest data between `timestamp-2*tolerance` and `timestamp`. Default value is `2*frequency` whe...(description truncated): 123",
20985
- "required": false,
22109
+ "info": "ID of ifa device: 123",
22110
+ "required": true,
20986
22111
  "schema": {
20987
- "title": "tolerance",
22112
+ "title": "id",
20988
22113
  "type": "number"
20989
22114
  }
20990
22115
  },
20991
22116
  {
20992
- "name": "device",
20993
- "type": "array",
20994
- "info": "list of devices under a device-group to be fetched: array",
22117
+ "name": "working",
22118
+ "type": "boolean",
22119
+ "info": "true queries undeployed configuration: boolean",
20995
22120
  "required": false,
20996
22121
  "schema": {
20997
- "title": "device",
20998
- "type": "array"
22122
+ "title": "working",
22123
+ "type": "boolean"
20999
22124
  }
21000
22125
  }
21001
22126
  ],
@@ -21013,43 +22138,40 @@
21013
22138
  ],
21014
22139
  "route": {
21015
22140
  "verb": "POST",
21016
- "path": "/retrieveHealthTreeByDeviceGroup"
22141
+ "path": "/retrieveHealthbotIngestIfaDeviceById"
21017
22142
  },
21018
22143
  "task": true
21019
22144
  },
21020
22145
  {
21021
- "name": "retrieveHealthTreeByNetworkGroup",
21022
- "summary": "retrieve_health_tree_by_network_group",
21023
- "description": "Get health-tree of a specified network-group.",
22146
+ "name": "createHealthbotIngestIfaDeviceById",
22147
+ "summary": "create_healthbot_ingest_ifa_device_by_id",
22148
+ "description": "Create operation of resource: device",
21024
22149
  "input": [
21025
22150
  {
21026
- "name": "networkGroupName",
21027
- "type": "string",
21028
- "info": "`network-group-name` of network-group: string",
22151
+ "name": "id",
22152
+ "type": "number",
22153
+ "info": "ID of ifa device: 123",
21029
22154
  "required": true,
21030
22155
  "schema": {
21031
- "title": "networkGroupName",
21032
- "type": "string"
21033
- }
21034
- },
21035
- {
21036
- "name": "timestamp",
21037
- "type": "string",
21038
- "info": "Timestamp at which health tree is requested. If not specified, current server timestamp is used.: string",
21039
- "required": false,
21040
- "schema": {
21041
- "title": "timestamp",
21042
- "type": "string"
22156
+ "title": "id",
22157
+ "type": "number"
21043
22158
  }
21044
22159
  },
21045
22160
  {
21046
- "name": "tolerance",
21047
- "type": "number",
21048
- "info": "Timestamp tolerance in seconds. With this option, health-tree will contain latest data between `timestamp-2*tolerance` and `timestamp`. Default value is `2*frequency` whe...(description truncated): 123",
21049
- "required": false,
22161
+ "name": "body",
22162
+ "type": "object",
22163
+ "info": "devicebody object: object",
22164
+ "required": true,
21050
22165
  "schema": {
21051
- "title": "tolerance",
21052
- "type": "number"
22166
+ "allOf": [
22167
+ {
22168
+ "type": "object"
22169
+ },
22170
+ {
22171
+ "description": "devicebody object"
22172
+ }
22173
+ ],
22174
+ "definitions": {}
21053
22175
  }
21054
22176
  }
21055
22177
  ],
@@ -21067,43 +22189,40 @@
21067
22189
  ],
21068
22190
  "route": {
21069
22191
  "verb": "POST",
21070
- "path": "/retrieveHealthTreeByNetworkGroup"
22192
+ "path": "/createHealthbotIngestIfaDeviceById"
21071
22193
  },
21072
22194
  "task": true
21073
22195
  },
21074
22196
  {
21075
- "name": "retrieveHealthTreeById",
21076
- "summary": "retrieve_health_tree_by_id",
21077
- "description": "Return health-tree of a specified device identified by `device-id`.",
22197
+ "name": "updateHealthbotIngestIfaDeviceById",
22198
+ "summary": "update_healthbot_ingest_ifa_device_by_id",
22199
+ "description": "Update operation of resource: device",
21078
22200
  "input": [
21079
22201
  {
21080
- "name": "deviceId",
22202
+ "name": "id",
21081
22203
  "type": "string",
21082
- "info": "`device-id` of device: string",
22204
+ "info": "ID of ifa device: string",
21083
22205
  "required": true,
21084
22206
  "schema": {
21085
- "title": "deviceId",
21086
- "type": "string"
21087
- }
21088
- },
21089
- {
21090
- "name": "timestamp",
21091
- "type": "string",
21092
- "info": "Timestamp at which health tree is requested. If not specified, current server timestamp is used.: string",
21093
- "required": false,
21094
- "schema": {
21095
- "title": "timestamp",
22207
+ "title": "id",
21096
22208
  "type": "string"
21097
22209
  }
21098
22210
  },
21099
22211
  {
21100
- "name": "tolerance",
21101
- "type": "number",
21102
- "info": "Timestamp tolerance in seconds. With this option, health-tree will contain latest data between `timestamp-2*tolerance` and `timestamp`. Default value is `2*frequency` whe...(description truncated): 123",
21103
- "required": false,
22212
+ "name": "body",
22213
+ "type": "object",
22214
+ "info": "devicebody object: object",
22215
+ "required": true,
21104
22216
  "schema": {
21105
- "title": "tolerance",
21106
- "type": "number"
22217
+ "allOf": [
22218
+ {
22219
+ "type": "object"
22220
+ },
22221
+ {
22222
+ "description": "devicebody object"
22223
+ }
22224
+ ],
22225
+ "definitions": {}
21107
22226
  }
21108
22227
  }
21109
22228
  ],
@@ -21121,15 +22240,33 @@
21121
22240
  ],
21122
22241
  "route": {
21123
22242
  "verb": "POST",
21124
- "path": "/retrieveHealthTreeById"
22243
+ "path": "/updateHealthbotIngestIfaDeviceById"
21125
22244
  },
21126
22245
  "task": true
21127
22246
  },
21128
22247
  {
21129
- "name": "retrieveHealthAll",
21130
- "summary": "retrieve_health_all",
21131
- "description": "Returns health of network-groups and devices in device-groups",
21132
- "input": [],
22248
+ "name": "postJunosEncode",
22249
+ "summary": "junosencode",
22250
+ "description": "Encode string with Junos",
22251
+ "input": [
22252
+ {
22253
+ "name": "body",
22254
+ "type": "object",
22255
+ "info": "String to Encode with Junos: object",
22256
+ "required": true,
22257
+ "schema": {
22258
+ "allOf": [
22259
+ {
22260
+ "type": "object"
22261
+ },
22262
+ {
22263
+ "description": "String to Encode with Junos"
22264
+ }
22265
+ ],
22266
+ "definitions": {}
22267
+ }
22268
+ }
22269
+ ],
21133
22270
  "output": {
21134
22271
  "name": "result",
21135
22272
  "type": "object",
@@ -21143,20 +22280,20 @@
21143
22280
  "admin"
21144
22281
  ],
21145
22282
  "route": {
21146
- "verb": "GET",
21147
- "path": "/retrieveHealthAll"
22283
+ "verb": "POST",
22284
+ "path": "/postJunosEncode"
21148
22285
  },
21149
22286
  "task": true
21150
22287
  },
21151
22288
  {
21152
- "name": "postInspectCommandRpcTable",
21153
- "summary": "inspect_command_rpc_table_on_device",
21154
- "description": "Inspect the given iAgent table on a device and return the results.",
22289
+ "name": "postJunosDecode",
22290
+ "summary": "junosdecode",
22291
+ "description": "Decode string with Junos",
21155
22292
  "input": [
21156
22293
  {
21157
22294
  "name": "body",
21158
22295
  "type": "object",
21159
- "info": "command-rpc object: object",
22296
+ "info": "String to Encode with Junos: object",
21160
22297
  "required": true,
21161
22298
  "schema": {
21162
22299
  "allOf": [
@@ -21164,7 +22301,7 @@
21164
22301
  "type": "object"
21165
22302
  },
21166
22303
  {
21167
- "description": "command-rpc object"
22304
+ "description": "String to Encode with Junos"
21168
22305
  }
21169
22306
  ],
21170
22307
  "definitions": {}
@@ -21185,7 +22322,7 @@
21185
22322
  ],
21186
22323
  "route": {
21187
22324
  "verb": "POST",
21188
- "path": "/postInspectCommandRpcTable"
22325
+ "path": "/postJunosDecode"
21189
22326
  },
21190
22327
  "task": true
21191
22328
  }