@itentialopensource/adapter-zscaler 0.6.7 → 0.8.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 (54) hide show
  1. package/AUTH.md +39 -0
  2. package/BROKER.md +199 -0
  3. package/CALLS.md +511 -0
  4. package/CHANGELOG.md +3 -94
  5. package/CODE_OF_CONDUCT.md +12 -17
  6. package/CONTRIBUTING.md +3 -148
  7. package/ENHANCE.md +69 -0
  8. package/PROPERTIES.md +641 -0
  9. package/README.md +235 -576
  10. package/SUMMARY.md +9 -0
  11. package/SYSTEMINFO.md +11 -0
  12. package/TROUBLESHOOT.md +47 -0
  13. package/adapter.js +292 -640
  14. package/adapterBase.js +843 -419
  15. package/changelogs/CHANGELOG.md +118 -0
  16. package/entities/.generic/action.json +105 -0
  17. package/entities/.generic/schema.json +6 -1
  18. package/error.json +6 -0
  19. package/metadata.json +49 -0
  20. package/package.json +25 -24
  21. package/pronghorn.json +527 -116
  22. package/propertiesDecorators.json +14 -0
  23. package/propertiesSchema.json +827 -6
  24. package/refs?service=git-upload-pack +0 -0
  25. package/report/adapter-openapi.json +1828 -0
  26. package/report/adapter-openapi.yaml +1462 -0
  27. package/report/adapterInfo.json +10 -0
  28. package/report/updateReport1653331963274.json +120 -0
  29. package/report/updateReport1691508819418.json +120 -0
  30. package/report/updateReport1692203278243.json +120 -0
  31. package/report/updateReport1694468959859.json +120 -0
  32. package/report/updateReport1698422816279.json +120 -0
  33. package/sampleProperties.json +153 -3
  34. package/test/integration/adapterTestBasicGet.js +3 -5
  35. package/test/integration/adapterTestConnectivity.js +91 -42
  36. package/test/integration/adapterTestIntegration.js +155 -109
  37. package/test/unit/adapterBaseTestUnit.js +388 -308
  38. package/test/unit/adapterTestUnit.js +399 -260
  39. package/utils/adapterInfo.js +206 -0
  40. package/utils/addAuth.js +1 -1
  41. package/utils/artifactize.js +1 -1
  42. package/utils/checkMigrate.js +1 -1
  43. package/utils/entitiesToDB.js +12 -57
  44. package/utils/findPath.js +1 -1
  45. package/utils/methodDocumentor.js +273 -0
  46. package/utils/modify.js +13 -15
  47. package/utils/packModificationScript.js +1 -1
  48. package/utils/pre-commit.sh +5 -0
  49. package/utils/taskMover.js +309 -0
  50. package/utils/tbScript.js +123 -53
  51. package/utils/tbUtils.js +87 -49
  52. package/utils/testRunner.js +17 -17
  53. package/utils/troubleshootingAdapter.js +9 -6
  54. package/workflows/README.md +0 -3
package/propertiesSchema.json CHANGED
@@ -18,6 +18,11 @@
18
18
  "minimum": 1,
19
19
  "maximum": 65535
20
20
  },
21
+ "choosepath": {
22
+ "type": "string",
23
+ "description": "choose the path to use -- requires entityPath choices",
24
+ "default": ""
25
+ },
21
26
  "base_path": {
22
27
  "type": "string",
23
28
  "description": "a base path that is consistent across api calls",
@@ -51,6 +56,11 @@
51
56
  "description": "When true the path variables are encoded in the url",
52
57
  "default": true
53
58
  },
59
+ "encode_queryvars": {
60
+ "type": "boolean",
61
+ "description": "When true the query parameters are encoded in the url",
62
+ "default": true
63
+ },
54
64
  "save_metric": {
55
65
  "type": [
56
66
  "boolean",
@@ -73,6 +83,14 @@
73
83
  "https"
74
84
  ]
75
85
  },
86
+ "service": {
87
+ "type": "string",
88
+ "description": "Service we are integrating with -- used with AWS Authentication",
89
+ "examples": [
90
+ "ec2",
91
+ "route53"
92
+ ]
93
+ },
76
94
  "authentication": {
77
95
  "$ref": "#/definitions/authentication"
78
96
  },
@@ -93,6 +111,12 @@
93
111
  },
94
112
  "mongo": {
95
113
  "$ref": "#/definitions/mongo"
114
+ },
115
+ "devicebroker": {
116
+ "$ref": "#/definitions/devicebroker"
117
+ },
118
+ "cache": {
119
+ "$ref": "#/definitions/cache"
96
120
  }
97
121
  },
98
122
  "required": [
@@ -114,7 +138,9 @@
114
138
  "static_token",
115
139
  "jwt_token",
116
140
  "request_token",
117
- "no_authentication"
141
+ "no_authentication",
142
+ "multi_step_authentication",
143
+ "aws_authentication"
118
144
  ]
119
145
  },
120
146
  "username": {
@@ -252,6 +278,74 @@
252
278
  "type": "string",
253
279
  "description": "The grant type for OAuth requests - can also provide in schema",
254
280
  "default": ""
281
+ },
282
+ "sensitive": {
283
+ "type": "array",
284
+ "description": "List of sensitive keys to search and hide values from being logged",
285
+ "default": [],
286
+ "items": {
287
+ "type": "string"
288
+ }
289
+ },
290
+ "sso": {
291
+ "type": "object",
292
+ "properties": {
293
+ "protocol": {
294
+ "type": "string",
295
+ "description": "the protocol to request token from system",
296
+ "default": "",
297
+ "enum": [
298
+ "http",
299
+ "https",
300
+ ""
301
+ ]
302
+ },
303
+ "host": {
304
+ "type": "string",
305
+ "description": "hostname of the authentication system",
306
+ "default": "",
307
+ "examples": [
308
+ "systemx.customer.com"
309
+ ]
310
+ },
311
+ "port": {
312
+ "type": "integer",
313
+ "description": "port on which to connect to the authentication system",
314
+ "default": 0,
315
+ "minimum": 0,
316
+ "maximum": 65535
317
+ }
318
+ }
319
+ },
320
+ "multiStepAuthCalls": {
321
+ "type": "array",
322
+ "items": {
323
+ "type": "object",
324
+ "properties": {
325
+ "name": {
326
+ "type": "string",
327
+ "description": "Id of the step call",
328
+ "examples": [
329
+ "getAccessToken"
330
+ ]
331
+ },
332
+ "requestFields": {
333
+ "type": "object",
334
+ "description": "The fields set in step request"
335
+ },
336
+ "responseFields": {
337
+ "type": "object",
338
+ "description": "The fields from the step result"
339
+ },
340
+ "successfullResponseCode": {
341
+ "type": "integer",
342
+ "description": "Expected response code for given step, if not set any successfull http response is accepted",
343
+ "examples": [
344
+ 200
345
+ ]
346
+ }
347
+ }
348
+ }
255
349
  }
256
350
  },
257
351
  "required": [
@@ -354,7 +448,13 @@
354
448
  },
355
449
  "query_object": {
356
450
  "type": "object",
357
- "description": "Query object { device: xxxxx } to be placed into the healthcheck, will be converted to query string by the adapter"
451
+ "description": "Query object { device: xxxxx } to be placed into the healthcheck, will be converted to query string by the adapter",
452
+ "default": {}
453
+ },
454
+ "addlHeaders": {
455
+ "type": "object",
456
+ "description": "headers that will be appended to the headers for the call",
457
+ "default": {}
358
458
  }
359
459
  },
360
460
  "required": [
@@ -434,6 +534,7 @@
434
534
  "priorities": {
435
535
  "type": "array",
436
536
  "description": "define your priorities here",
537
+ "default": [],
437
538
  "items": {
438
539
  "type": "object",
439
540
  "properties": {
@@ -504,6 +605,7 @@
504
605
  "failover_codes": {
505
606
  "type": "array",
506
607
  "description": "An array of codes where it is ok to try another method",
608
+ "default": [],
507
609
  "items": {
508
610
  "type": "integer"
509
611
  }
@@ -521,19 +623,23 @@
521
623
  "properties": {
522
624
  "payload": {
523
625
  "type": "object",
524
- "description": "payload fields that will be appended to the provided payload (excluding GET calls)"
626
+ "description": "payload fields that will be appended to the provided payload (excluding GET calls)",
627
+ "default": {}
525
628
  },
526
629
  "uriOptions": {
527
630
  "type": "object",
528
- "description": "options that will be appended to all GET calls"
631
+ "description": "options that will be appended to all GET calls",
632
+ "default": {}
529
633
  },
530
634
  "addlHeaders": {
531
635
  "type": "object",
532
- "description": "headers that will be appended to the headers for the call"
636
+ "description": "headers that will be appended to the headers for the call",
637
+ "default": {}
533
638
  },
534
639
  "authData": {
535
640
  "type": "object",
536
- "description": "authentication data that will be appended to the payload for authentication calls"
641
+ "description": "authentication data that will be appended to the payload for authentication calls",
642
+ "default": {}
537
643
  }
538
644
  }
539
645
  },
@@ -840,6 +946,721 @@
840
946
  }
841
947
  }
842
948
  }
949
+ },
950
+ "devicebroker": {
951
+ "type": "object",
952
+ "properties": {
953
+ "getDevice": {
954
+ "type": "array",
955
+ "description": "Broker call(s) to getDevice",
956
+ "items": {
957
+ "type": "object",
958
+ "properties": {
959
+ "path": {
960
+ "type": "string",
961
+ "description": "The fully qualified path of the call to getDevice (e.g. /rest/api/device/{deviceid})",
962
+ "default": ""
963
+ },
964
+ "method": {
965
+ "type": "string",
966
+ "description": "The method of the call to getDevice",
967
+ "default": "GET"
968
+ },
969
+ "query": {
970
+ "type": "object",
971
+ "description": "The json object with query parameters of the call to getDevice",
972
+ "additionalProperties": {
973
+ "type": [
974
+ "string",
975
+ "number"
976
+ ]
977
+ }
978
+ },
979
+ "body": {
980
+ "type": "object",
981
+ "description": "The json object with body of the call to getDevice",
982
+ "additionalProperties": {
983
+ "type": [
984
+ "string",
985
+ "number"
986
+ ]
987
+ }
988
+ },
989
+ "headers": {
990
+ "type": "object",
991
+ "description": "The json object with headers of the call to getDevice",
992
+ "additionalProperties": {
993
+ "type": [
994
+ "string",
995
+ "number"
996
+ ]
997
+ }
998
+ },
999
+ "handleFailure": {
1000
+ "type": "string",
1001
+ "enum": [
1002
+ "ignore",
1003
+ "fail"
1004
+ ],
1005
+ "description": "return failure or ignore failure",
1006
+ "default": "ignore"
1007
+ },
1008
+ "requestFields": {
1009
+ "type": "object",
1010
+ "description": "The json object with response fields of the call to getDevice",
1011
+ "additionalProperties": {
1012
+ "type": [
1013
+ "string",
1014
+ "number"
1015
+ ]
1016
+ },
1017
+ "properties": {}
1018
+ },
1019
+ "responseDatakey": {
1020
+ "type": "string",
1021
+ "description": "place in the response where the data is - supports jsonquery",
1022
+ "default": ""
1023
+ },
1024
+ "responseFields": {
1025
+ "type": "object",
1026
+ "description": "The json object with response fields of the call to getDevice",
1027
+ "additionalProperties": {
1028
+ "type": [
1029
+ "string",
1030
+ "number"
1031
+ ]
1032
+ },
1033
+ "properties": {
1034
+ "name": {
1035
+ "type": "string",
1036
+ "description": "The field in response to getDevice that contains the name of the device",
1037
+ "default": "name"
1038
+ },
1039
+ "ostype": {
1040
+ "type": "string",
1041
+ "description": "The field in response to getDevice that contains the ostype of the device",
1042
+ "default": "ostype"
1043
+ },
1044
+ "ostypePrefix": {
1045
+ "type": "string",
1046
+ "description": "Any prefix that should be added to the ostype of the device (e.g. aws-)",
1047
+ "default": ""
1048
+ },
1049
+ "port": {
1050
+ "type": "string",
1051
+ "description": "The field in response to getDevice that contains the port of the device",
1052
+ "default": ""
1053
+ },
1054
+ "ipaddress": {
1055
+ "type": "string",
1056
+ "description": "The field in response to getDevice that contains the ip address of the device",
1057
+ "default": ""
1058
+ }
1059
+ }
1060
+ }
1061
+ }
1062
+ }
1063
+ },
1064
+ "getDevicesFiltered": {
1065
+ "type": "array",
1066
+ "description": "Broker call(s) to getDevicesFiltered",
1067
+ "items": {
1068
+ "type": "object",
1069
+ "properties": {
1070
+ "path": {
1071
+ "type": "string",
1072
+ "description": "The fully qualified path of the call to getDevicesFiltered (e.g. /rest/api/device/{deviceid})",
1073
+ "default": ""
1074
+ },
1075
+ "method": {
1076
+ "type": "string",
1077
+ "description": "The method of the call to getDevicesFiltered",
1078
+ "default": "GET"
1079
+ },
1080
+ "pagination": {
1081
+ "type": "object",
1082
+ "description": "todo",
1083
+ "properties": {
1084
+ "offsetVar": {
1085
+ "type": "string",
1086
+ "description": "Name of variable that defines how to go to next set of results"
1087
+ },
1088
+ "limitVar": {
1089
+ "type": "string",
1090
+ "description": "Name of variable that defines the max results returned in a request"
1091
+ },
1092
+ "incrementBy": {
1093
+ "type": "string",
1094
+ "enum": [
1095
+ "limit",
1096
+ "page"
1097
+ ],
1098
+ "description": "How to incremenet offset. Default limit",
1099
+ "default": "limit"
1100
+ },
1101
+ "requestLocation": {
1102
+ "type": "string",
1103
+ "enum": [
1104
+ "query",
1105
+ "body"
1106
+ ],
1107
+ "description": "Where in request the pagination data goes",
1108
+ "default": "query"
1109
+ }
1110
+ }
1111
+ },
1112
+ "query": {
1113
+ "type": "object",
1114
+ "description": "The json object with query parameters of the call to getDevicesFiltered",
1115
+ "additionalProperties": {
1116
+ "type": [
1117
+ "string",
1118
+ "number"
1119
+ ]
1120
+ }
1121
+ },
1122
+ "body": {
1123
+ "type": "object",
1124
+ "description": "The json object with body of the call to getDevicesFiltered",
1125
+ "additionalProperties": {
1126
+ "type": [
1127
+ "string",
1128
+ "number"
1129
+ ]
1130
+ }
1131
+ },
1132
+ "headers": {
1133
+ "type": "object",
1134
+ "description": "The json object with headers of the call to getDevicesFiltered",
1135
+ "additionalProperties": {
1136
+ "type": [
1137
+ "string",
1138
+ "number"
1139
+ ]
1140
+ }
1141
+ },
1142
+ "handleFailure": {
1143
+ "type": "string",
1144
+ "enum": [
1145
+ "ignore",
1146
+ "fail"
1147
+ ],
1148
+ "description": "return failure or ignore failure",
1149
+ "default": "ignore"
1150
+ },
1151
+ "requestFields": {
1152
+ "type": "object",
1153
+ "description": "The json object with response fields of the call to getDevice",
1154
+ "additionalProperties": {
1155
+ "type": [
1156
+ "string",
1157
+ "number"
1158
+ ]
1159
+ },
1160
+ "properties": {}
1161
+ },
1162
+ "responseDatakey": {
1163
+ "type": "string",
1164
+ "description": "place in the response where the data is - supports jsonquery",
1165
+ "default": ""
1166
+ },
1167
+ "responseFields": {
1168
+ "type": "object",
1169
+ "description": "The json object with response fields of the call to getDevicesFiltered",
1170
+ "additionalProperties": {
1171
+ "type": [
1172
+ "string",
1173
+ "number"
1174
+ ]
1175
+ },
1176
+ "properties": {
1177
+ "name": {
1178
+ "type": "string",
1179
+ "description": "The field in response to getDevicesFiltered that contains the name of the device",
1180
+ "default": "name"
1181
+ },
1182
+ "ostype": {
1183
+ "type": "string",
1184
+ "description": "The field in response to getDevicesFiltered that contains the ostype of the device",
1185
+ "default": "ostype"
1186
+ },
1187
+ "ostypePrefix": {
1188
+ "type": "string",
1189
+ "description": "Any prefix that should be added to the ostype of the device (e.g. aws-)",
1190
+ "default": ""
1191
+ },
1192
+ "port": {
1193
+ "type": "string",
1194
+ "description": "The field in response to getDevicesFiltered that contains the port of the device",
1195
+ "default": ""
1196
+ },
1197
+ "ipaddress": {
1198
+ "type": "string",
1199
+ "description": "The field in response to getDevicesFiltered that contains the ip address of the device",
1200
+ "default": ""
1201
+ }
1202
+ }
1203
+ }
1204
+ }
1205
+ }
1206
+ },
1207
+ "isAlive": {
1208
+ "type": "array",
1209
+ "description": "Broker call(s) to determine if the device isAlive",
1210
+ "items": {
1211
+ "type": "object",
1212
+ "properties": {
1213
+ "path": {
1214
+ "type": "string",
1215
+ "description": "The fully qualified path of the call to isAlive (e.g. /rest/api/device/{deviceid})",
1216
+ "default": ""
1217
+ },
1218
+ "method": {
1219
+ "type": "string",
1220
+ "description": "The method of the call to isAlive",
1221
+ "default": "GET"
1222
+ },
1223
+ "query": {
1224
+ "type": "object",
1225
+ "description": "The json object with query parameters of the call to isAlive",
1226
+ "additionalProperties": {
1227
+ "type": [
1228
+ "string",
1229
+ "number"
1230
+ ]
1231
+ }
1232
+ },
1233
+ "body": {
1234
+ "type": "object",
1235
+ "description": "The json object with body of the call to isAlive",
1236
+ "additionalProperties": {
1237
+ "type": [
1238
+ "string",
1239
+ "number"
1240
+ ]
1241
+ }
1242
+ },
1243
+ "headers": {
1244
+ "type": "object",
1245
+ "description": "The json object with headers of the call to isAlive",
1246
+ "additionalProperties": {
1247
+ "type": [
1248
+ "string",
1249
+ "number"
1250
+ ]
1251
+ }
1252
+ },
1253
+ "handleFailure": {
1254
+ "type": "string",
1255
+ "enum": [
1256
+ "ignore",
1257
+ "fail"
1258
+ ],
1259
+ "description": "return failure or ignore isAlive",
1260
+ "default": "ignore"
1261
+ },
1262
+ "requestFields": {
1263
+ "type": "object",
1264
+ "description": "The json object with response fields of the call to getDevice",
1265
+ "additionalProperties": {
1266
+ "type": [
1267
+ "string",
1268
+ "number"
1269
+ ]
1270
+ },
1271
+ "properties": {}
1272
+ },
1273
+ "responseDatakey": {
1274
+ "type": "string",
1275
+ "description": "place in the response where the data is - supports jsonquery",
1276
+ "default": ""
1277
+ },
1278
+ "responseFields": {
1279
+ "type": "object",
1280
+ "description": "The json object with response fields of the call to isAlive",
1281
+ "additionalProperties": {
1282
+ "type": [
1283
+ "string",
1284
+ "number"
1285
+ ]
1286
+ },
1287
+ "properties": {
1288
+ "status": {
1289
+ "type": "string",
1290
+ "description": "The field in response to isAlive that contains the status of the device",
1291
+ "default": "name"
1292
+ },
1293
+ "statusValue": {
1294
+ "type": "string",
1295
+ "description": "The expected value in the status field",
1296
+ "default": "true"
1297
+ }
1298
+ }
1299
+ }
1300
+ }
1301
+ }
1302
+ },
1303
+ "getConfig": {
1304
+ "type": "array",
1305
+ "description": "Broker call(s) to getConfig",
1306
+ "items": {
1307
+ "type": "object",
1308
+ "properties": {
1309
+ "path": {
1310
+ "type": "string",
1311
+ "description": "The fully qualified path of the call to getConfig (e.g. /rest/api/device/{deviceid})",
1312
+ "default": ""
1313
+ },
1314
+ "method": {
1315
+ "type": "string",
1316
+ "description": "The method of the call to getConfig",
1317
+ "default": "GET"
1318
+ },
1319
+ "query": {
1320
+ "type": "object",
1321
+ "description": "The json object with query parameters of the call to getConfig",
1322
+ "additionalProperties": {
1323
+ "type": [
1324
+ "string",
1325
+ "number"
1326
+ ]
1327
+ }
1328
+ },
1329
+ "body": {
1330
+ "type": "object",
1331
+ "description": "The json object with body of the call to getConfig",
1332
+ "additionalProperties": {
1333
+ "type": [
1334
+ "string",
1335
+ "number"
1336
+ ]
1337
+ }
1338
+ },
1339
+ "headers": {
1340
+ "type": "object",
1341
+ "description": "The json object with headers of the call to getConfig",
1342
+ "additionalProperties": {
1343
+ "type": [
1344
+ "string",
1345
+ "number"
1346
+ ]
1347
+ }
1348
+ },
1349
+ "handleFailure": {
1350
+ "type": "string",
1351
+ "enum": [
1352
+ "ignore",
1353
+ "fail"
1354
+ ],
1355
+ "description": "return failure or ignore getConfig",
1356
+ "default": "ignore"
1357
+ },
1358
+ "requestFields": {
1359
+ "type": "object",
1360
+ "description": "The json object with response fields of the call to getDevice",
1361
+ "additionalProperties": {
1362
+ "type": [
1363
+ "string",
1364
+ "number"
1365
+ ]
1366
+ },
1367
+ "properties": {}
1368
+ },
1369
+ "responseDatakey": {
1370
+ "type": "string",
1371
+ "description": "place in the response where the data is - supports jsonquery",
1372
+ "default": ""
1373
+ },
1374
+ "responseFields": {
1375
+ "type": "object",
1376
+ "description": "The json object with response fields of the call to getConfig",
1377
+ "additionalProperties": {
1378
+ "type": [
1379
+ "string",
1380
+ "number"
1381
+ ]
1382
+ },
1383
+ "properties": {}
1384
+ }
1385
+ }
1386
+ }
1387
+ },
1388
+ "getCount": {
1389
+ "type": "array",
1390
+ "description": "Broker call(s) to getCount",
1391
+ "items": {
1392
+ "type": "object",
1393
+ "properties": {
1394
+ "path": {
1395
+ "type": "string",
1396
+ "description": "The fully qualified path of the call to getCount (e.g. /rest/api/device/{deviceid})",
1397
+ "default": ""
1398
+ },
1399
+ "method": {
1400
+ "type": "string",
1401
+ "description": "The method of the call to getCount",
1402
+ "default": "GET"
1403
+ },
1404
+ "query": {
1405
+ "type": "object",
1406
+ "description": "The json object with query parameters of the call to getCount",
1407
+ "additionalProperties": {
1408
+ "type": [
1409
+ "string",
1410
+ "number"
1411
+ ]
1412
+ }
1413
+ },
1414
+ "body": {
1415
+ "type": "object",
1416
+ "description": "The json object with body of the call to getCount",
1417
+ "additionalProperties": {
1418
+ "type": [
1419
+ "string",
1420
+ "number"
1421
+ ]
1422
+ }
1423
+ },
1424
+ "headers": {
1425
+ "type": "object",
1426
+ "description": "The json object with headers of the call to getCount",
1427
+ "additionalProperties": {
1428
+ "type": [
1429
+ "string",
1430
+ "number"
1431
+ ]
1432
+ }
1433
+ },
1434
+ "handleFailure": {
1435
+ "type": "string",
1436
+ "enum": [
1437
+ "ignore",
1438
+ "fail"
1439
+ ],
1440
+ "description": "return failure or ignore getCount",
1441
+ "default": "ignore"
1442
+ },
1443
+ "requestFields": {
1444
+ "type": "object",
1445
+ "description": "The json object with response fields of the call to getDevice",
1446
+ "additionalProperties": {
1447
+ "type": [
1448
+ "string",
1449
+ "number"
1450
+ ]
1451
+ },
1452
+ "properties": {}
1453
+ },
1454
+ "responseDatakey": {
1455
+ "type": "string",
1456
+ "description": "place in the response where the data is - supports jsonquery",
1457
+ "default": ""
1458
+ },
1459
+ "responseFields": {
1460
+ "type": "object",
1461
+ "description": "The json object with response fields of the call to getConfig",
1462
+ "additionalProperties": {
1463
+ "type": [
1464
+ "string",
1465
+ "number"
1466
+ ]
1467
+ },
1468
+ "properties": {}
1469
+ }
1470
+ }
1471
+ }
1472
+ }
1473
+ }
1474
+ },
1475
+ "cache": {
1476
+ "type": "object",
1477
+ "properties": {
1478
+ "enabled": {
1479
+ "type": "boolean",
1480
+ "description": "Whether or not cache is enabled for adapter",
1481
+ "default": false
1482
+ },
1483
+ "entities": {
1484
+ "type": "array",
1485
+ "description": "Information for the cached entities",
1486
+ "items": {
1487
+ "type": "object",
1488
+ "properties": {
1489
+ "entityType": {
1490
+ "type": "string",
1491
+ "description": "The name of the entity - should match adapter entity configuration or a broker (e.g. Device)",
1492
+ "default": ""
1493
+ },
1494
+ "frequency": {
1495
+ "type": "integer",
1496
+ "description": "how long (in minutes) we wait to re-populate the cache",
1497
+ "default": 1440,
1498
+ "maximum": 10080
1499
+ },
1500
+ "flushOnFail": {
1501
+ "type": "boolean",
1502
+ "description": "Whether to clear the cache we have if the populate failed",
1503
+ "default": false
1504
+ },
1505
+ "limit": {
1506
+ "type": "integer",
1507
+ "description": "maximum number of items to keep in cache",
1508
+ "default": 1000
1509
+ },
1510
+ "retryAttempts": {
1511
+ "type": "integer",
1512
+ "description": "number of times to retry the populate call before failure",
1513
+ "default": 5
1514
+ },
1515
+ "sort": {
1516
+ "type": "boolean",
1517
+ "description": "whether to sort the data or not",
1518
+ "default": true
1519
+ },
1520
+ "populate": {
1521
+ "type": "array",
1522
+ "description": "Information for the call(s) used to populate the cache",
1523
+ "items": {
1524
+ "type": "object",
1525
+ "properties": {
1526
+ "path": {
1527
+ "type": "string",
1528
+ "description": "The fully qualified path of the call to getDevice (e.g. /rest/api/device/{deviceid})",
1529
+ "default": ""
1530
+ },
1531
+ "method": {
1532
+ "type": "string",
1533
+ "description": "The method of the call to getDevice",
1534
+ "default": "GET"
1535
+ },
1536
+ "pagination": {
1537
+ "type": "object",
1538
+ "description": "todo",
1539
+ "properties": {
1540
+ "offsetVar": {
1541
+ "type": "string",
1542
+ "description": "Name of variable that defines how to go to next set of results"
1543
+ },
1544
+ "limitVar": {
1545
+ "type": "string",
1546
+ "description": "Name of variable that defines the max results returned in a request"
1547
+ },
1548
+ "incrementBy": {
1549
+ "type": "string",
1550
+ "enum": [
1551
+ "limit",
1552
+ "page"
1553
+ ],
1554
+ "description": "How to incremenet offset. Default limit",
1555
+ "default": "limit"
1556
+ },
1557
+ "requestLocation": {
1558
+ "type": "string",
1559
+ "enum": [
1560
+ "query",
1561
+ "body"
1562
+ ],
1563
+ "description": "Where in request the pagination data goes",
1564
+ "default": "query"
1565
+ }
1566
+ }
1567
+ },
1568
+ "query": {
1569
+ "type": "object",
1570
+ "description": "The json object with query parameters of the call to getDevice",
1571
+ "additionalProperties": {
1572
+ "type": [
1573
+ "string",
1574
+ "number"
1575
+ ]
1576
+ }
1577
+ },
1578
+ "body": {
1579
+ "type": "object",
1580
+ "description": "The json object with body of the call to getDevice",
1581
+ "additionalProperties": {
1582
+ "type": [
1583
+ "string",
1584
+ "number"
1585
+ ]
1586
+ }
1587
+ },
1588
+ "headers": {
1589
+ "type": "object",
1590
+ "description": "The json object with headers of the call to getDevice",
1591
+ "additionalProperties": {
1592
+ "type": [
1593
+ "string",
1594
+ "number"
1595
+ ]
1596
+ }
1597
+ },
1598
+ "handleFailure": {
1599
+ "type": "string",
1600
+ "enum": [
1601
+ "ignore",
1602
+ "fail"
1603
+ ],
1604
+ "description": "return failure or ignore failure",
1605
+ "default": "ignore"
1606
+ },
1607
+ "requestFields": {
1608
+ "type": "object",
1609
+ "description": "The json object with response fields of the call to getDevice",
1610
+ "additionalProperties": {
1611
+ "type": [
1612
+ "string",
1613
+ "number"
1614
+ ]
1615
+ },
1616
+ "properties": {}
1617
+ },
1618
+ "responseDatakey": {
1619
+ "type": "string",
1620
+ "description": "place in the response where the data is - supports jsonquery",
1621
+ "default": ""
1622
+ },
1623
+ "responseFields": {
1624
+ "type": "object",
1625
+ "description": "The json object with response fields of the call to getDevice",
1626
+ "additionalProperties": {
1627
+ "type": [
1628
+ "string",
1629
+ "number"
1630
+ ]
1631
+ }
1632
+ }
1633
+ }
1634
+ }
1635
+ },
1636
+ "cachedTasks": {
1637
+ "type": "array",
1638
+ "description": "Information for the call(s) used to populate the cache",
1639
+ "items": {
1640
+ "type": "object",
1641
+ "properties": {
1642
+ "name": {
1643
+ "type": "string",
1644
+ "description": "the name of the task/action that should utilize cached information",
1645
+ "default": ""
1646
+ },
1647
+ "filterField": {
1648
+ "type": "string",
1649
+ "description": "the field that contains filter information for this call",
1650
+ "default": ""
1651
+ },
1652
+ "filterLoc": {
1653
+ "type": "string",
1654
+ "description": "the field that contains the location of the filter field",
1655
+ "default": ""
1656
+ }
1657
+ }
1658
+ }
1659
+ }
1660
+ }
1661
+ }
1662
+ }
1663
+ }
843
1664
  }
844
1665
  }
845
1666
  }