@itentialopensource/adapter-checkpoint_management 0.5.0 → 0.6.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.
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",
@@ -339,64 +349,85 @@
339
349
  "task": true
340
350
  },
341
351
  {
342
- "name": "genericAdapterRequest",
343
- "summary": "Makes the requested generic call",
344
- "description": "Makes the requested generic call",
352
+ "name": "iapDeactivateTasks",
353
+ "summary": "Deactivate the inputted tasks",
354
+ "description": "Deactivate the inputted tasks",
345
355
  "input": [
346
356
  {
347
- "name": "uriPath",
348
- "type": "string",
349
- "info": "the path of the api call - do not include the host, port, base path or version",
350
- "description": "the path of the api call",
357
+ "name": "tasks",
358
+ "type": "array",
359
+ "description": "Tasks to deactivate",
351
360
  "schema": {
352
- "title": "uriPath",
353
- "type": "string"
354
- },
355
- "required": true
356
- },
357
- {
358
- "name": "restMethod",
359
- "type": "string",
360
- "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
361
- "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
362
- "schema": {
363
- "title": "restMethod",
364
- "type": "string"
365
- },
366
- "required": true
367
- },
368
- {
369
- "name": "queryData",
370
- "type": "object",
371
- "info": "the query parameters to be put on the url (optional)",
372
- "description": "the query parameters to be put on the url (optional)",
373
- "schema": {
374
- "title": "queryData",
375
- "type": "object"
376
- },
377
- "required": false
378
- },
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": [
379
389
  {
380
- "name": "requestBody",
381
- "type": "object",
382
- "info": "the payload to be sent with the request (optional)",
383
- "description": "the payload to be sent with the request (optional)",
390
+ "name": "tasks",
391
+ "type": "array",
392
+ "description": "Tasks to activate",
384
393
  "schema": {
385
- "title": "requestBody",
386
- "type": "object"
387
- },
388
- "required": false
389
- },
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": [
390
422
  {
391
- "name": "addlHeaders",
392
- "type": "object",
393
- "info": "additional headers to be put on the call (optional)",
394
- "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,
395
427
  "schema": {
396
- "title": "addlHeaders",
397
- "type": "object"
398
- },
399
- "required": false
428
+ "title": "entityTypes",
429
+ "type": "array"
430
+ }
400
431
  }
401
432
  ],
402
433
  "output": {
@@ -413,69 +444,34 @@
413
444
  ],
414
445
  "route": {
415
446
  "verb": "POST",
416
- "path": "/genericAdapterRequest"
447
+ "path": "/iapPopulateEntityCache"
417
448
  },
418
449
  "task": true
419
450
  },
420
451
  {
421
- "name": "genericAdapterRequestNoBasePath",
422
- "summary": "Makes the requested generic call with no base path or version",
423
- "description": "Makes the requested generic call with no base path or version",
452
+ "name": "iapRetrieveEntitiesCache",
453
+ "summary": "Retrieves data from cache for specified entity type",
454
+ "description": "Retrieves data from cache for specified entity type",
424
455
  "input": [
425
456
  {
426
- "name": "uriPath",
427
- "type": "string",
428
- "info": "the path of the api call - do not include the host, port, base path or version",
429
- "description": "the path of the api call",
430
- "schema": {
431
- "title": "uriPath",
432
- "type": "string"
433
- },
434
- "required": true
435
- },
436
- {
437
- "name": "restMethod",
457
+ "name": "entityType",
438
458
  "type": "string",
439
- "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
440
- "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
459
+ "info": "entity of which to retrieve",
460
+ "required": true,
441
461
  "schema": {
442
- "title": "restMethod",
462
+ "title": "entityType",
443
463
  "type": "string"
444
- },
445
- "required": true
446
- },
447
- {
448
- "name": "queryData",
449
- "type": "object",
450
- "info": "the query parameters to be put on the url (optional)",
451
- "description": "the query parameters to be put on the url (optional)",
452
- "schema": {
453
- "title": "queryData",
454
- "type": "object"
455
- },
456
- "required": false
457
- },
458
- {
459
- "name": "requestBody",
460
- "type": "object",
461
- "info": "the payload to be sent with the request (optional)",
462
- "description": "the payload to be sent with the request (optional)",
463
- "schema": {
464
- "title": "requestBody",
465
- "type": "object"
466
- },
467
- "required": false
464
+ }
468
465
  },
469
466
  {
470
- "name": "addlHeaders",
467
+ "name": "options",
471
468
  "type": "object",
472
- "info": "additional headers to be put on the call (optional)",
473
- "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,
474
471
  "schema": {
475
- "title": "addlHeaders",
472
+ "title": "options",
476
473
  "type": "object"
477
- },
478
- "required": false
474
+ }
479
475
  }
480
476
  ],
481
477
  "output": {
@@ -492,7 +488,7 @@
492
488
  ],
493
489
  "route": {
494
490
  "verb": "POST",
495
- "path": "/genericAdapterRequestNoBasePath"
491
+ "path": "/iapRetrieveEntitiesCache"
496
492
  },
497
493
  "task": true
498
494
  },
@@ -665,6 +661,334 @@
665
661
  },
666
662
  "task": false
667
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
+ },
668
992
  {
669
993
  "name": "login",
670
994
  "summary": "login",