@itentialopensource/adapter-infoblox 1.12.4 → 1.13.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 (44) hide show
  1. package/AUTH.md +4 -9
  2. package/CALLS.md +2033 -22
  3. package/CHANGELOG.md +8 -0
  4. package/CONTRIBUTING.md +1 -160
  5. package/ENHANCE.md +2 -2
  6. package/README.md +32 -23
  7. package/SYSTEMINFO.md +13 -3
  8. package/adapter.js +171 -333
  9. package/adapterBase.js +549 -879
  10. package/changelogs/changelog.md +212 -0
  11. package/metadata.json +68 -0
  12. package/package.json +24 -24
  13. package/pronghorn.json +470 -138
  14. package/propertiesSchema.json +422 -31
  15. package/refs?service=git-upload-pack +0 -0
  16. package/report/adapter-openapi.json +11283 -0
  17. package/report/adapter-openapi.yaml +8812 -0
  18. package/report/adapterInfo.json +8 -8
  19. package/report/updateReport1691508491036.json +120 -0
  20. package/report/updateReport1692202976507.json +120 -0
  21. package/report/updateReport1694466431390.json +120 -0
  22. package/sampleProperties.json +63 -2
  23. package/test/integration/adapterTestBasicGet.js +2 -4
  24. package/test/integration/adapterTestConnectivity.js +91 -42
  25. package/test/integration/adapterTestIntegration.js +130 -2
  26. package/test/unit/adapterBaseTestUnit.js +388 -313
  27. package/test/unit/adapterTestUnit.js +343 -117
  28. package/utils/adapterInfo.js +1 -1
  29. package/utils/addAuth.js +1 -1
  30. package/utils/artifactize.js +1 -1
  31. package/utils/checkMigrate.js +1 -1
  32. package/utils/entitiesToDB.js +2 -2
  33. package/utils/findPath.js +1 -1
  34. package/utils/methodDocumentor.js +260 -0
  35. package/utils/modify.js +13 -15
  36. package/utils/packModificationScript.js +1 -1
  37. package/utils/pre-commit.sh +2 -0
  38. package/utils/taskMover.js +309 -0
  39. package/utils/tbScript.js +89 -34
  40. package/utils/tbUtils.js +41 -21
  41. package/utils/testRunner.js +1 -1
  42. package/utils/troubleshootingAdapter.js +9 -6
  43. package/workflows/Object entity.json +0 -1
  44. package/workflows/README.md +0 -3
package/pronghorn.json CHANGED
@@ -63,47 +63,22 @@
63
63
  "title": "action",
64
64
  "type": "string"
65
65
  }
66
- }
67
- ],
68
- "output": {
69
- "name": "result",
70
- "type": "object",
71
- "description": "A JSON Object containing status, code and the result",
72
- "schema": {
73
- "title": "result",
74
- "type": "object"
75
- }
76
- },
77
- "roles": [
78
- "admin"
79
- ],
80
- "route": {
81
- "verb": "POST",
82
- "path": "/iapUpdateAdapterConfiguration"
83
- },
84
- "task": true
85
- },
86
- {
87
- "name": "iapFindAdapterPath",
88
- "summary": "Provides the ability to see if a particular API path is supported by the adapter",
89
- "description": "Provides the ability to see if a particular API path is supported by the adapter",
90
- "input": [
66
+ },
91
67
  {
92
- "name": "apiPath",
93
- "type": "string",
94
- "info": "The API Path you want to check - make sure to not include base path and version",
95
- "description": "The API Path you want to check - make sure to not include base path and version",
68
+ "name": "replace",
69
+ "type": "boolean",
70
+ "info": "True to replace entire mock data, false to merge/append",
71
+ "required": false,
96
72
  "schema": {
97
- "title": "apiPath",
98
- "type": "string"
99
- },
100
- "required": true
73
+ "title": "replace",
74
+ "type": "boolean"
75
+ }
101
76
  }
102
77
  ],
103
78
  "output": {
104
79
  "name": "result",
105
80
  "type": "object",
106
- "description": "A JSON Object containing the result",
81
+ "description": "A JSON Object containing status, code and the result",
107
82
  "schema": {
108
83
  "title": "result",
109
84
  "type": "object"
@@ -114,7 +89,7 @@
114
89
  ],
115
90
  "route": {
116
91
  "verb": "POST",
117
- "path": "/iapFindAdapterPath"
92
+ "path": "/iapUpdateAdapterConfiguration"
118
93
  },
119
94
  "task": true
120
95
  },
@@ -203,6 +178,41 @@
203
178
  },
204
179
  "task": true
205
180
  },
181
+ {
182
+ "name": "iapFindAdapterPath",
183
+ "summary": "Provides the ability to see if a particular API path is supported by the adapter",
184
+ "description": "Provides the ability to see if a particular API path is supported by the adapter",
185
+ "input": [
186
+ {
187
+ "name": "apiPath",
188
+ "type": "string",
189
+ "info": "The API Path you want to check - make sure to not include base path and version",
190
+ "description": "The API Path you want to check - make sure to not include base path and version",
191
+ "schema": {
192
+ "title": "apiPath",
193
+ "type": "string"
194
+ },
195
+ "required": true
196
+ }
197
+ ],
198
+ "output": {
199
+ "name": "result",
200
+ "type": "object",
201
+ "description": "A JSON Object containing the result",
202
+ "schema": {
203
+ "title": "result",
204
+ "type": "object"
205
+ }
206
+ },
207
+ "roles": [
208
+ "admin"
209
+ ],
210
+ "route": {
211
+ "verb": "POST",
212
+ "path": "/iapFindAdapterPath"
213
+ },
214
+ "task": true
215
+ },
206
216
  {
207
217
  "name": "iapTroubleshootAdapter",
208
218
  "summary": "Runs troubleshoot script for adapter",
@@ -222,7 +232,11 @@
222
232
  "name": "persistFlag",
223
233
  "type": "boolean",
224
234
  "info": "Whether the input properties should be saved",
225
- "required": true
235
+ "required": true,
236
+ "schema": {
237
+ "title": "persistFlag",
238
+ "type": "boolean"
239
+ }
226
240
  }
227
241
  ],
228
242
  "output": {
@@ -251,7 +265,11 @@
251
265
  "output": {
252
266
  "name": "result",
253
267
  "type": "boolean",
254
- "description": "Whether healthcheck passed or failed"
268
+ "description": "Whether healthcheck passed or failed",
269
+ "schema": {
270
+ "title": "result",
271
+ "type": "boolean"
272
+ }
255
273
  },
256
274
  "roles": [
257
275
  "admin"
@@ -332,64 +350,85 @@
332
350
  "task": true
333
351
  },
334
352
  {
335
- "name": "genericAdapterRequest",
336
- "summary": "Makes the requested generic call",
337
- "description": "Makes the requested generic call",
353
+ "name": "iapDeactivateTasks",
354
+ "summary": "Deactivate the inputted tasks",
355
+ "description": "Deactivate the inputted tasks",
338
356
  "input": [
339
357
  {
340
- "name": "uriPath",
341
- "type": "string",
342
- "info": "the path of the api call - do not include the host, port, base path or version",
343
- "description": "the path of the api call",
344
- "schema": {
345
- "title": "uriPath",
346
- "type": "string"
347
- },
348
- "required": true
349
- },
350
- {
351
- "name": "restMethod",
352
- "type": "string",
353
- "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
354
- "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
355
- "schema": {
356
- "title": "restMethod",
357
- "type": "string"
358
- },
359
- "required": true
360
- },
361
- {
362
- "name": "queryData",
363
- "type": "object",
364
- "info": "the query parameters to be put on the url (optional)",
365
- "description": "the query parameters to be put on the url (optional)",
358
+ "name": "tasks",
359
+ "type": "array",
360
+ "description": "Tasks to deactivate",
366
361
  "schema": {
367
- "title": "queryData",
368
- "type": "object"
369
- },
370
- "required": false
371
- },
362
+ "title": "tasks",
363
+ "type": "array"
364
+ }
365
+ }
366
+ ],
367
+ "output": {
368
+ "name": "result",
369
+ "type": "object",
370
+ "description": "A JSON Object containing success status",
371
+ "schema": {
372
+ "title": "result",
373
+ "type": "object"
374
+ }
375
+ },
376
+ "roles": [
377
+ "admin"
378
+ ],
379
+ "route": {
380
+ "verb": "POST",
381
+ "path": "/iapDeactivateTasks"
382
+ },
383
+ "task": true
384
+ },
385
+ {
386
+ "name": "iapActivateTasks",
387
+ "summary": "Activate the inputted tasks",
388
+ "description": "activate the inputted tasks",
389
+ "input": [
372
390
  {
373
- "name": "requestBody",
374
- "type": "object",
375
- "info": "the payload to be sent with the request (optional)",
376
- "description": "the payload to be sent with the request (optional)",
391
+ "name": "tasks",
392
+ "type": "array",
393
+ "description": "Tasks to activate",
377
394
  "schema": {
378
- "title": "requestBody",
379
- "type": "object"
380
- },
381
- "required": false
382
- },
395
+ "title": "tasks",
396
+ "type": "array"
397
+ }
398
+ }
399
+ ],
400
+ "output": {
401
+ "name": "result",
402
+ "type": "object",
403
+ "description": "A JSON Object containing success status",
404
+ "schema": {
405
+ "title": "result",
406
+ "type": "object"
407
+ }
408
+ },
409
+ "roles": [
410
+ "admin"
411
+ ],
412
+ "route": {
413
+ "verb": "POST",
414
+ "path": "/iapActivateTasks"
415
+ },
416
+ "task": true
417
+ },
418
+ {
419
+ "name": "iapPopulateEntityCache",
420
+ "summary": "Populate the cache for the given entities",
421
+ "description": "Populate the cache for the given entities",
422
+ "input": [
383
423
  {
384
- "name": "addlHeaders",
385
- "type": "object",
386
- "info": "additional headers to be put on the call (optional)",
387
- "description": "additional headers to be put on the call (optional)",
424
+ "name": "entityTypes",
425
+ "type": "array",
426
+ "info": "the entity type(s) to populate",
427
+ "required": true,
388
428
  "schema": {
389
- "title": "addlHeaders",
390
- "type": "object"
391
- },
392
- "required": false
429
+ "title": "entityTypes",
430
+ "type": "array"
431
+ }
393
432
  }
394
433
  ],
395
434
  "output": {
@@ -406,69 +445,34 @@
406
445
  ],
407
446
  "route": {
408
447
  "verb": "POST",
409
- "path": "/genericAdapterRequest"
448
+ "path": "/iapPopulateEntityCache"
410
449
  },
411
450
  "task": true
412
451
  },
413
452
  {
414
- "name": "genericAdapterRequestNoBasePath",
415
- "summary": "Makes the requested generic call with no base path or version",
416
- "description": "Makes the requested generic call with no base path or version",
453
+ "name": "iapRetrieveEntitiesCache",
454
+ "summary": "Retrieves data from cache for specified entity type",
455
+ "description": "Retrieves data from cache for specified entity type",
417
456
  "input": [
418
457
  {
419
- "name": "uriPath",
420
- "type": "string",
421
- "info": "the path of the api call - do not include the host, port, base path or version",
422
- "description": "the path of the api call",
423
- "schema": {
424
- "title": "uriPath",
425
- "type": "string"
426
- },
427
- "required": true
428
- },
429
- {
430
- "name": "restMethod",
458
+ "name": "entityType",
431
459
  "type": "string",
432
- "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
433
- "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
460
+ "info": "entity of which to retrieve",
461
+ "required": true,
434
462
  "schema": {
435
- "title": "restMethod",
463
+ "title": "entityType",
436
464
  "type": "string"
437
- },
438
- "required": true
439
- },
440
- {
441
- "name": "queryData",
442
- "type": "object",
443
- "info": "the query parameters to be put on the url (optional)",
444
- "description": "the query parameters to be put on the url (optional)",
445
- "schema": {
446
- "title": "queryData",
447
- "type": "object"
448
- },
449
- "required": false
450
- },
451
- {
452
- "name": "requestBody",
453
- "type": "object",
454
- "info": "the payload to be sent with the request (optional)",
455
- "description": "the payload to be sent with the request (optional)",
456
- "schema": {
457
- "title": "requestBody",
458
- "type": "object"
459
- },
460
- "required": false
465
+ }
461
466
  },
462
467
  {
463
- "name": "addlHeaders",
468
+ "name": "options",
464
469
  "type": "object",
465
- "info": "additional headers to be put on the call (optional)",
466
- "description": "additional headers to be put on the call (optional)",
470
+ "info": "settings of which data to return and how to return it",
471
+ "required": false,
467
472
  "schema": {
468
- "title": "addlHeaders",
473
+ "title": "options",
469
474
  "type": "object"
470
- },
471
- "required": false
475
+ }
472
476
  }
473
477
  ],
474
478
  "output": {
@@ -485,7 +489,7 @@
485
489
  ],
486
490
  "route": {
487
491
  "verb": "POST",
488
- "path": "/genericAdapterRequestNoBasePath"
492
+ "path": "/iapRetrieveEntitiesCache"
489
493
  },
490
494
  "task": true
491
495
  },
@@ -658,6 +662,334 @@
658
662
  },
659
663
  "task": false
660
664
  },
665
+ {
666
+ "name": "iapExpandedGenericAdapterRequest",
667
+ "summary": "Makes the requested generic call with additional options",
668
+ "description": "Makes the requested generic call with additional options via metadata",
669
+ "input": [
670
+ {
671
+ "name": "metadata",
672
+ "type": "object",
673
+ "info": "metadata for the call (optional)",
674
+ "description": "metadata for the call - allows for many enhancements (optional)",
675
+ "schema": {
676
+ "title": "metadata",
677
+ "type": "object"
678
+ },
679
+ "required": false
680
+ },
681
+ {
682
+ "name": "uriPath",
683
+ "type": "string",
684
+ "info": "the path of the api call - do not include the host, port, base path or version",
685
+ "description": "the path of the api call",
686
+ "schema": {
687
+ "title": "uriPath",
688
+ "type": "string"
689
+ },
690
+ "required": false
691
+ },
692
+ {
693
+ "name": "restMethod",
694
+ "type": "string",
695
+ "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
696
+ "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
697
+ "schema": {
698
+ "title": "restMethod",
699
+ "type": "string"
700
+ },
701
+ "required": false
702
+ },
703
+ {
704
+ "name": "pathVars",
705
+ "type": "object",
706
+ "info": "the parameters to be put within the url path (optional)",
707
+ "description": "the parameters to be put within the url path (optional)",
708
+ "schema": {
709
+ "title": "pathVars",
710
+ "type": "object"
711
+ },
712
+ "required": false
713
+ },
714
+ {
715
+ "name": "queryData",
716
+ "type": "object",
717
+ "info": "the query parameters to be put on the url (optional)",
718
+ "description": "the query parameters to be put on the url (optional)",
719
+ "schema": {
720
+ "title": "queryData",
721
+ "type": "object"
722
+ },
723
+ "required": false
724
+ },
725
+ {
726
+ "name": "requestBody",
727
+ "type": "object",
728
+ "info": "the payload to be sent with the request (optional)",
729
+ "description": "the payload to be sent with the request (optional)",
730
+ "schema": {
731
+ "title": "requestBody",
732
+ "type": "object"
733
+ },
734
+ "required": false
735
+ },
736
+ {
737
+ "name": "addlHeaders",
738
+ "type": "object",
739
+ "info": "additional headers to be put on the call (optional)",
740
+ "description": "additional headers to be put on the call (optional)",
741
+ "schema": {
742
+ "title": "addlHeaders",
743
+ "type": "object"
744
+ },
745
+ "required": false
746
+ }
747
+ ],
748
+ "output": {
749
+ "name": "result",
750
+ "type": "object",
751
+ "description": "A JSON Object containing status, code and the result",
752
+ "schema": {
753
+ "title": "result",
754
+ "type": "object"
755
+ }
756
+ },
757
+ "roles": [
758
+ "admin"
759
+ ],
760
+ "route": {
761
+ "verb": "POST",
762
+ "path": "/iapExpandedGenericAdapterRequest"
763
+ },
764
+ "task": true
765
+ },
766
+ {
767
+ "name": "genericAdapterRequest",
768
+ "summary": "Makes the requested generic call",
769
+ "description": "Makes the requested generic call",
770
+ "input": [
771
+ {
772
+ "name": "uriPath",
773
+ "type": "string",
774
+ "info": "the path of the api call - do not include the host, port, base path or version",
775
+ "description": "the path of the api call",
776
+ "schema": {
777
+ "title": "uriPath",
778
+ "type": "string"
779
+ },
780
+ "required": true
781
+ },
782
+ {
783
+ "name": "restMethod",
784
+ "type": "string",
785
+ "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
786
+ "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
787
+ "schema": {
788
+ "title": "restMethod",
789
+ "type": "string"
790
+ },
791
+ "required": true
792
+ },
793
+ {
794
+ "name": "queryData",
795
+ "type": "object",
796
+ "info": "the query parameters to be put on the url (optional)",
797
+ "description": "the query parameters to be put on the url (optional)",
798
+ "schema": {
799
+ "title": "queryData",
800
+ "type": "object"
801
+ },
802
+ "required": false
803
+ },
804
+ {
805
+ "name": "requestBody",
806
+ "type": "object",
807
+ "info": "the payload to be sent with the request (optional)",
808
+ "description": "the payload to be sent with the request (optional)",
809
+ "schema": {
810
+ "title": "requestBody",
811
+ "type": "object"
812
+ },
813
+ "required": false
814
+ },
815
+ {
816
+ "name": "addlHeaders",
817
+ "type": "object",
818
+ "info": "additional headers to be put on the call (optional)",
819
+ "description": "additional headers to be put on the call (optional)",
820
+ "schema": {
821
+ "title": "addlHeaders",
822
+ "type": "object"
823
+ },
824
+ "required": false
825
+ }
826
+ ],
827
+ "output": {
828
+ "name": "result",
829
+ "type": "object",
830
+ "description": "A JSON Object containing status, code and the result",
831
+ "schema": {
832
+ "title": "result",
833
+ "type": "object"
834
+ }
835
+ },
836
+ "roles": [
837
+ "admin"
838
+ ],
839
+ "route": {
840
+ "verb": "POST",
841
+ "path": "/genericAdapterRequest"
842
+ },
843
+ "task": true
844
+ },
845
+ {
846
+ "name": "genericAdapterRequestNoBasePath",
847
+ "summary": "Makes the requested generic call",
848
+ "description": "Makes the requested generic call",
849
+ "input": [
850
+ {
851
+ "name": "uriPath",
852
+ "type": "string",
853
+ "info": "the path of the api call - do not include the host, port, base path or version",
854
+ "description": "the path of the api call",
855
+ "schema": {
856
+ "title": "uriPath",
857
+ "type": "string"
858
+ },
859
+ "required": true
860
+ },
861
+ {
862
+ "name": "restMethod",
863
+ "type": "string",
864
+ "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
865
+ "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
866
+ "schema": {
867
+ "title": "restMethod",
868
+ "type": "string"
869
+ },
870
+ "required": true
871
+ },
872
+ {
873
+ "name": "queryData",
874
+ "type": "object",
875
+ "info": "the query parameters to be put on the url (optional)",
876
+ "description": "the query parameters to be put on the url (optional)",
877
+ "schema": {
878
+ "title": "queryData",
879
+ "type": "object"
880
+ },
881
+ "required": false
882
+ },
883
+ {
884
+ "name": "requestBody",
885
+ "type": "object",
886
+ "info": "the payload to be sent with the request (optional)",
887
+ "description": "the payload to be sent with the request (optional)",
888
+ "schema": {
889
+ "title": "requestBody",
890
+ "type": "object"
891
+ },
892
+ "required": false
893
+ },
894
+ {
895
+ "name": "addlHeaders",
896
+ "type": "object",
897
+ "info": "additional headers to be put on the call (optional)",
898
+ "description": "additional headers to be put on the call (optional)",
899
+ "schema": {
900
+ "title": "addlHeaders",
901
+ "type": "object"
902
+ },
903
+ "required": false
904
+ }
905
+ ],
906
+ "output": {
907
+ "name": "result",
908
+ "type": "object",
909
+ "description": "A JSON Object containing status, code and the result",
910
+ "schema": {
911
+ "title": "result",
912
+ "type": "object"
913
+ }
914
+ },
915
+ "roles": [
916
+ "admin"
917
+ ],
918
+ "route": {
919
+ "verb": "POST",
920
+ "path": "/genericAdapterRequestNoBasePath"
921
+ },
922
+ "task": true
923
+ },
924
+ {
925
+ "name": "iapRunAdapterLint",
926
+ "summary": "Run the adapter lint script to return the results",
927
+ "description": "Run the adapter lint script to return the results",
928
+ "input": [],
929
+ "output": {
930
+ "name": "result",
931
+ "type": "string",
932
+ "description": "A string containing the run results",
933
+ "schema": {
934
+ "title": "result",
935
+ "type": "string"
936
+ }
937
+ },
938
+ "roles": [
939
+ "admin"
940
+ ],
941
+ "route": {
942
+ "verb": "GET",
943
+ "path": "/iapRunAdapterLint"
944
+ },
945
+ "task": true
946
+ },
947
+ {
948
+ "name": "iapRunAdapterTests",
949
+ "summary": "Run the adapter test scripts (baseunit and unit) to return the results",
950
+ "description": "Run the adapter test scripts (baseunit and unit) to return the results",
951
+ "input": [],
952
+ "output": {
953
+ "name": "result",
954
+ "type": "object",
955
+ "description": "A JSON Object containing status, code and the result",
956
+ "schema": {
957
+ "title": "result",
958
+ "type": "object"
959
+ }
960
+ },
961
+ "roles": [
962
+ "admin"
963
+ ],
964
+ "route": {
965
+ "verb": "GET",
966
+ "path": "/iapRunAdapterTests"
967
+ },
968
+ "task": true
969
+ },
970
+ {
971
+ "name": "iapGetAdapterInventory",
972
+ "summary": "Provide inventory information abbout the adapter",
973
+ "description": "Provide inventory information abbout the adapter",
974
+ "input": [],
975
+ "output": {
976
+ "name": "result",
977
+ "type": "object",
978
+ "description": "A JSON Object containing status, code and the result",
979
+ "schema": {
980
+ "title": "result",
981
+ "type": "object"
982
+ }
983
+ },
984
+ "roles": [
985
+ "admin"
986
+ ],
987
+ "route": {
988
+ "verb": "GET",
989
+ "path": "/iapGetAdapterInventory"
990
+ },
991
+ "task": true
992
+ },
661
993
  {
662
994
  "name": "createNetwork",
663
995
  "summary": "createNetwork",