@itentialopensource/adapter-robustel 0.2.0 → 0.3.1
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/CALLS.md +36 -0
- package/CHANGELOG.md +16 -0
- package/CONTRIBUTING.md +1 -160
- package/ENHANCE.md +2 -2
- package/README.md +32 -23
- package/adapter.js +155 -163
- package/adapterBase.js +549 -879
- package/changelogs/changelog.md +16 -0
- package/metadata.json +47 -0
- package/package.json +23 -25
- package/pronghorn.json +983 -644
- package/propertiesSchema.json +431 -31
- package/refs?service=git-upload-pack +0 -0
- package/report/adapter-openapi.json +204 -0
- package/report/adapter-openapi.yaml +163 -0
- package/report/adapterInfo.json +8 -8
- package/report/updateReport1691507608338.json +120 -0
- package/report/updateReport1692202610637.json +120 -0
- package/report/updateReport1694462053440.json +120 -0
- package/report/updateReport1698421016757.json +120 -0
- package/sampleProperties.json +62 -2
- package/test/integration/adapterTestBasicGet.js +2 -4
- package/test/integration/adapterTestConnectivity.js +91 -42
- package/test/integration/adapterTestIntegration.js +130 -2
- package/test/unit/adapterBaseTestUnit.js +388 -313
- package/test/unit/adapterTestUnit.js +338 -112
- package/utils/adapterInfo.js +1 -1
- package/utils/addAuth.js +1 -1
- package/utils/artifactize.js +1 -1
- package/utils/checkMigrate.js +1 -1
- package/utils/entitiesToDB.js +2 -2
- package/utils/findPath.js +1 -1
- package/utils/methodDocumentor.js +273 -0
- package/utils/modify.js +13 -15
- package/utils/packModificationScript.js +1 -1
- package/utils/pre-commit.sh +2 -0
- package/utils/taskMover.js +309 -0
- package/utils/tbScript.js +89 -34
- package/utils/tbUtils.js +41 -21
- package/utils/testRunner.js +1 -1
- package/utils/troubleshootingAdapter.js +9 -6
- 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",
|
|
@@ -78,6 +83,14 @@
|
|
|
78
83
|
"https"
|
|
79
84
|
]
|
|
80
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
|
+
},
|
|
81
94
|
"authentication": {
|
|
82
95
|
"$ref": "#/definitions/authentication"
|
|
83
96
|
},
|
|
@@ -101,6 +114,9 @@
|
|
|
101
114
|
},
|
|
102
115
|
"devicebroker": {
|
|
103
116
|
"$ref": "#/definitions/devicebroker"
|
|
117
|
+
},
|
|
118
|
+
"cache": {
|
|
119
|
+
"$ref": "#/definitions/cache"
|
|
104
120
|
}
|
|
105
121
|
},
|
|
106
122
|
"required": [
|
|
@@ -122,7 +138,9 @@
|
|
|
122
138
|
"static_token",
|
|
123
139
|
"jwt_token",
|
|
124
140
|
"request_token",
|
|
125
|
-
"no_authentication"
|
|
141
|
+
"no_authentication",
|
|
142
|
+
"multi_step_authentication",
|
|
143
|
+
"aws_authentication"
|
|
126
144
|
]
|
|
127
145
|
},
|
|
128
146
|
"username": {
|
|
@@ -270,6 +288,74 @@
|
|
|
270
288
|
"type": "string",
|
|
271
289
|
"description": "The unique code for the signature request",
|
|
272
290
|
"default": ""
|
|
291
|
+
},
|
|
292
|
+
"sensitive": {
|
|
293
|
+
"type": "array",
|
|
294
|
+
"description": "List of sensitive keys to search and hide values from being logged",
|
|
295
|
+
"default": [],
|
|
296
|
+
"items": {
|
|
297
|
+
"type": "string"
|
|
298
|
+
}
|
|
299
|
+
},
|
|
300
|
+
"sso": {
|
|
301
|
+
"type": "object",
|
|
302
|
+
"properties": {
|
|
303
|
+
"protocol": {
|
|
304
|
+
"type": "string",
|
|
305
|
+
"description": "the protocol to request token from system",
|
|
306
|
+
"default": "",
|
|
307
|
+
"enum": [
|
|
308
|
+
"http",
|
|
309
|
+
"https",
|
|
310
|
+
""
|
|
311
|
+
]
|
|
312
|
+
},
|
|
313
|
+
"host": {
|
|
314
|
+
"type": "string",
|
|
315
|
+
"description": "hostname of the authentication system",
|
|
316
|
+
"default": "",
|
|
317
|
+
"examples": [
|
|
318
|
+
"systemx.customer.com"
|
|
319
|
+
]
|
|
320
|
+
},
|
|
321
|
+
"port": {
|
|
322
|
+
"type": "integer",
|
|
323
|
+
"description": "port on which to connect to the authentication system",
|
|
324
|
+
"default": 0,
|
|
325
|
+
"minimum": 0,
|
|
326
|
+
"maximum": 65535
|
|
327
|
+
}
|
|
328
|
+
}
|
|
329
|
+
},
|
|
330
|
+
"multiStepAuthCalls": {
|
|
331
|
+
"type": "array",
|
|
332
|
+
"items": {
|
|
333
|
+
"type": "object",
|
|
334
|
+
"properties": {
|
|
335
|
+
"name": {
|
|
336
|
+
"type": "string",
|
|
337
|
+
"description": "Id of the step call",
|
|
338
|
+
"examples": [
|
|
339
|
+
"getAccessToken"
|
|
340
|
+
]
|
|
341
|
+
},
|
|
342
|
+
"requestFields": {
|
|
343
|
+
"type": "object",
|
|
344
|
+
"description": "The fields set in step request"
|
|
345
|
+
},
|
|
346
|
+
"responseFields": {
|
|
347
|
+
"type": "object",
|
|
348
|
+
"description": "The fields from the step result"
|
|
349
|
+
},
|
|
350
|
+
"successfullResponseCode": {
|
|
351
|
+
"type": "integer",
|
|
352
|
+
"description": "Expected response code for given step, if not set any successfull http response is accepted",
|
|
353
|
+
"examples": [
|
|
354
|
+
200
|
|
355
|
+
]
|
|
356
|
+
}
|
|
357
|
+
}
|
|
358
|
+
}
|
|
273
359
|
}
|
|
274
360
|
},
|
|
275
361
|
"required": [
|
|
@@ -372,7 +458,13 @@
|
|
|
372
458
|
},
|
|
373
459
|
"query_object": {
|
|
374
460
|
"type": "object",
|
|
375
|
-
"description": "Query object { device: xxxxx } to be placed into the healthcheck, will be converted to query string by the adapter"
|
|
461
|
+
"description": "Query object { device: xxxxx } to be placed into the healthcheck, will be converted to query string by the adapter",
|
|
462
|
+
"default": {}
|
|
463
|
+
},
|
|
464
|
+
"addlHeaders": {
|
|
465
|
+
"type": "object",
|
|
466
|
+
"description": "headers that will be appended to the headers for the call",
|
|
467
|
+
"default": {}
|
|
376
468
|
}
|
|
377
469
|
},
|
|
378
470
|
"required": [
|
|
@@ -452,6 +544,7 @@
|
|
|
452
544
|
"priorities": {
|
|
453
545
|
"type": "array",
|
|
454
546
|
"description": "define your priorities here",
|
|
547
|
+
"default": [],
|
|
455
548
|
"items": {
|
|
456
549
|
"type": "object",
|
|
457
550
|
"properties": {
|
|
@@ -522,6 +615,7 @@
|
|
|
522
615
|
"failover_codes": {
|
|
523
616
|
"type": "array",
|
|
524
617
|
"description": "An array of codes where it is ok to try another method",
|
|
618
|
+
"default": [],
|
|
525
619
|
"items": {
|
|
526
620
|
"type": "integer"
|
|
527
621
|
}
|
|
@@ -539,19 +633,23 @@
|
|
|
539
633
|
"properties": {
|
|
540
634
|
"payload": {
|
|
541
635
|
"type": "object",
|
|
542
|
-
"description": "payload fields that will be appended to the provided payload (excluding GET calls)"
|
|
636
|
+
"description": "payload fields that will be appended to the provided payload (excluding GET calls)",
|
|
637
|
+
"default": {}
|
|
543
638
|
},
|
|
544
639
|
"uriOptions": {
|
|
545
640
|
"type": "object",
|
|
546
|
-
"description": "options that will be appended to all GET calls"
|
|
641
|
+
"description": "options that will be appended to all GET calls",
|
|
642
|
+
"default": {}
|
|
547
643
|
},
|
|
548
644
|
"addlHeaders": {
|
|
549
645
|
"type": "object",
|
|
550
|
-
"description": "headers that will be appended to the headers for the call"
|
|
646
|
+
"description": "headers that will be appended to the headers for the call",
|
|
647
|
+
"default": {}
|
|
551
648
|
},
|
|
552
649
|
"authData": {
|
|
553
650
|
"type": "object",
|
|
554
|
-
"description": "authentication data that will be appended to the payload for authentication calls"
|
|
651
|
+
"description": "authentication data that will be appended to the payload for authentication calls",
|
|
652
|
+
"default": {}
|
|
555
653
|
}
|
|
556
654
|
}
|
|
557
655
|
},
|
|
@@ -866,6 +964,7 @@
|
|
|
866
964
|
"type": "array",
|
|
867
965
|
"description": "Broker call(s) to getDevice",
|
|
868
966
|
"items": {
|
|
967
|
+
"type": "object",
|
|
869
968
|
"properties": {
|
|
870
969
|
"path": {
|
|
871
970
|
"type": "string",
|
|
@@ -881,21 +980,30 @@
|
|
|
881
980
|
"type": "object",
|
|
882
981
|
"description": "The json object with query parameters of the call to getDevice",
|
|
883
982
|
"additionalProperties": {
|
|
884
|
-
"type":
|
|
983
|
+
"type": [
|
|
984
|
+
"string",
|
|
985
|
+
"number"
|
|
986
|
+
]
|
|
885
987
|
}
|
|
886
988
|
},
|
|
887
989
|
"body": {
|
|
888
990
|
"type": "object",
|
|
889
991
|
"description": "The json object with body of the call to getDevice",
|
|
890
992
|
"additionalProperties": {
|
|
891
|
-
"type":
|
|
993
|
+
"type": [
|
|
994
|
+
"string",
|
|
995
|
+
"number"
|
|
996
|
+
]
|
|
892
997
|
}
|
|
893
998
|
},
|
|
894
999
|
"headers": {
|
|
895
1000
|
"type": "object",
|
|
896
1001
|
"description": "The json object with headers of the call to getDevice",
|
|
897
1002
|
"additionalProperties": {
|
|
898
|
-
"type":
|
|
1003
|
+
"type": [
|
|
1004
|
+
"string",
|
|
1005
|
+
"number"
|
|
1006
|
+
]
|
|
899
1007
|
}
|
|
900
1008
|
},
|
|
901
1009
|
"handleFailure": {
|
|
@@ -911,7 +1019,10 @@
|
|
|
911
1019
|
"type": "object",
|
|
912
1020
|
"description": "The json object with response fields of the call to getDevice",
|
|
913
1021
|
"additionalProperties": {
|
|
914
|
-
"type":
|
|
1022
|
+
"type": [
|
|
1023
|
+
"string",
|
|
1024
|
+
"number"
|
|
1025
|
+
]
|
|
915
1026
|
},
|
|
916
1027
|
"properties": {}
|
|
917
1028
|
},
|
|
@@ -924,7 +1035,10 @@
|
|
|
924
1035
|
"type": "object",
|
|
925
1036
|
"description": "The json object with response fields of the call to getDevice",
|
|
926
1037
|
"additionalProperties": {
|
|
927
|
-
"type":
|
|
1038
|
+
"type": [
|
|
1039
|
+
"string",
|
|
1040
|
+
"number"
|
|
1041
|
+
]
|
|
928
1042
|
},
|
|
929
1043
|
"properties": {
|
|
930
1044
|
"name": {
|
|
@@ -961,6 +1075,7 @@
|
|
|
961
1075
|
"type": "array",
|
|
962
1076
|
"description": "Broker call(s) to getDevicesFiltered",
|
|
963
1077
|
"items": {
|
|
1078
|
+
"type": "object",
|
|
964
1079
|
"properties": {
|
|
965
1080
|
"path": {
|
|
966
1081
|
"type": "string",
|
|
@@ -972,25 +1087,66 @@
|
|
|
972
1087
|
"description": "The method of the call to getDevicesFiltered",
|
|
973
1088
|
"default": "GET"
|
|
974
1089
|
},
|
|
1090
|
+
"pagination": {
|
|
1091
|
+
"type": "object",
|
|
1092
|
+
"description": "todo",
|
|
1093
|
+
"properties": {
|
|
1094
|
+
"offsetVar": {
|
|
1095
|
+
"type": "string",
|
|
1096
|
+
"description": "Name of variable that defines how to go to next set of results"
|
|
1097
|
+
},
|
|
1098
|
+
"limitVar": {
|
|
1099
|
+
"type": "string",
|
|
1100
|
+
"description": "Name of variable that defines the max results returned in a request"
|
|
1101
|
+
},
|
|
1102
|
+
"incrementBy": {
|
|
1103
|
+
"type": "string",
|
|
1104
|
+
"enum": [
|
|
1105
|
+
"limit",
|
|
1106
|
+
"page"
|
|
1107
|
+
],
|
|
1108
|
+
"description": "How to incremenet offset. Default limit",
|
|
1109
|
+
"default": "limit"
|
|
1110
|
+
},
|
|
1111
|
+
"requestLocation": {
|
|
1112
|
+
"type": "string",
|
|
1113
|
+
"enum": [
|
|
1114
|
+
"query",
|
|
1115
|
+
"body"
|
|
1116
|
+
],
|
|
1117
|
+
"description": "Where in request the pagination data goes",
|
|
1118
|
+
"default": "query"
|
|
1119
|
+
}
|
|
1120
|
+
}
|
|
1121
|
+
},
|
|
975
1122
|
"query": {
|
|
976
1123
|
"type": "object",
|
|
977
1124
|
"description": "The json object with query parameters of the call to getDevicesFiltered",
|
|
978
1125
|
"additionalProperties": {
|
|
979
|
-
"type":
|
|
1126
|
+
"type": [
|
|
1127
|
+
"string",
|
|
1128
|
+
"number"
|
|
1129
|
+
]
|
|
980
1130
|
}
|
|
981
1131
|
},
|
|
982
1132
|
"body": {
|
|
983
1133
|
"type": "object",
|
|
984
1134
|
"description": "The json object with body of the call to getDevicesFiltered",
|
|
985
1135
|
"additionalProperties": {
|
|
986
|
-
"type":
|
|
1136
|
+
"type": [
|
|
1137
|
+
"string",
|
|
1138
|
+
"number"
|
|
1139
|
+
]
|
|
987
1140
|
}
|
|
988
1141
|
},
|
|
989
1142
|
"headers": {
|
|
990
1143
|
"type": "object",
|
|
991
1144
|
"description": "The json object with headers of the call to getDevicesFiltered",
|
|
992
1145
|
"additionalProperties": {
|
|
993
|
-
"type":
|
|
1146
|
+
"type": [
|
|
1147
|
+
"string",
|
|
1148
|
+
"number"
|
|
1149
|
+
]
|
|
994
1150
|
}
|
|
995
1151
|
},
|
|
996
1152
|
"handleFailure": {
|
|
@@ -1006,7 +1162,10 @@
|
|
|
1006
1162
|
"type": "object",
|
|
1007
1163
|
"description": "The json object with response fields of the call to getDevice",
|
|
1008
1164
|
"additionalProperties": {
|
|
1009
|
-
"type":
|
|
1165
|
+
"type": [
|
|
1166
|
+
"string",
|
|
1167
|
+
"number"
|
|
1168
|
+
]
|
|
1010
1169
|
},
|
|
1011
1170
|
"properties": {}
|
|
1012
1171
|
},
|
|
@@ -1019,7 +1178,10 @@
|
|
|
1019
1178
|
"type": "object",
|
|
1020
1179
|
"description": "The json object with response fields of the call to getDevicesFiltered",
|
|
1021
1180
|
"additionalProperties": {
|
|
1022
|
-
"type":
|
|
1181
|
+
"type": [
|
|
1182
|
+
"string",
|
|
1183
|
+
"number"
|
|
1184
|
+
]
|
|
1023
1185
|
},
|
|
1024
1186
|
"properties": {
|
|
1025
1187
|
"name": {
|
|
@@ -1056,6 +1218,7 @@
|
|
|
1056
1218
|
"type": "array",
|
|
1057
1219
|
"description": "Broker call(s) to determine if the device isAlive",
|
|
1058
1220
|
"items": {
|
|
1221
|
+
"type": "object",
|
|
1059
1222
|
"properties": {
|
|
1060
1223
|
"path": {
|
|
1061
1224
|
"type": "string",
|
|
@@ -1071,21 +1234,30 @@
|
|
|
1071
1234
|
"type": "object",
|
|
1072
1235
|
"description": "The json object with query parameters of the call to isAlive",
|
|
1073
1236
|
"additionalProperties": {
|
|
1074
|
-
"type":
|
|
1237
|
+
"type": [
|
|
1238
|
+
"string",
|
|
1239
|
+
"number"
|
|
1240
|
+
]
|
|
1075
1241
|
}
|
|
1076
1242
|
},
|
|
1077
1243
|
"body": {
|
|
1078
1244
|
"type": "object",
|
|
1079
1245
|
"description": "The json object with body of the call to isAlive",
|
|
1080
1246
|
"additionalProperties": {
|
|
1081
|
-
"type":
|
|
1247
|
+
"type": [
|
|
1248
|
+
"string",
|
|
1249
|
+
"number"
|
|
1250
|
+
]
|
|
1082
1251
|
}
|
|
1083
1252
|
},
|
|
1084
1253
|
"headers": {
|
|
1085
1254
|
"type": "object",
|
|
1086
1255
|
"description": "The json object with headers of the call to isAlive",
|
|
1087
1256
|
"additionalProperties": {
|
|
1088
|
-
"type":
|
|
1257
|
+
"type": [
|
|
1258
|
+
"string",
|
|
1259
|
+
"number"
|
|
1260
|
+
]
|
|
1089
1261
|
}
|
|
1090
1262
|
},
|
|
1091
1263
|
"handleFailure": {
|
|
@@ -1101,7 +1273,10 @@
|
|
|
1101
1273
|
"type": "object",
|
|
1102
1274
|
"description": "The json object with response fields of the call to getDevice",
|
|
1103
1275
|
"additionalProperties": {
|
|
1104
|
-
"type":
|
|
1276
|
+
"type": [
|
|
1277
|
+
"string",
|
|
1278
|
+
"number"
|
|
1279
|
+
]
|
|
1105
1280
|
},
|
|
1106
1281
|
"properties": {}
|
|
1107
1282
|
},
|
|
@@ -1114,7 +1289,10 @@
|
|
|
1114
1289
|
"type": "object",
|
|
1115
1290
|
"description": "The json object with response fields of the call to isAlive",
|
|
1116
1291
|
"additionalProperties": {
|
|
1117
|
-
"type":
|
|
1292
|
+
"type": [
|
|
1293
|
+
"string",
|
|
1294
|
+
"number"
|
|
1295
|
+
]
|
|
1118
1296
|
},
|
|
1119
1297
|
"properties": {
|
|
1120
1298
|
"status": {
|
|
@@ -1136,6 +1314,7 @@
|
|
|
1136
1314
|
"type": "array",
|
|
1137
1315
|
"description": "Broker call(s) to getConfig",
|
|
1138
1316
|
"items": {
|
|
1317
|
+
"type": "object",
|
|
1139
1318
|
"properties": {
|
|
1140
1319
|
"path": {
|
|
1141
1320
|
"type": "string",
|
|
@@ -1151,21 +1330,30 @@
|
|
|
1151
1330
|
"type": "object",
|
|
1152
1331
|
"description": "The json object with query parameters of the call to getConfig",
|
|
1153
1332
|
"additionalProperties": {
|
|
1154
|
-
"type":
|
|
1333
|
+
"type": [
|
|
1334
|
+
"string",
|
|
1335
|
+
"number"
|
|
1336
|
+
]
|
|
1155
1337
|
}
|
|
1156
1338
|
},
|
|
1157
1339
|
"body": {
|
|
1158
1340
|
"type": "object",
|
|
1159
1341
|
"description": "The json object with body of the call to getConfig",
|
|
1160
1342
|
"additionalProperties": {
|
|
1161
|
-
"type":
|
|
1343
|
+
"type": [
|
|
1344
|
+
"string",
|
|
1345
|
+
"number"
|
|
1346
|
+
]
|
|
1162
1347
|
}
|
|
1163
1348
|
},
|
|
1164
1349
|
"headers": {
|
|
1165
1350
|
"type": "object",
|
|
1166
1351
|
"description": "The json object with headers of the call to getConfig",
|
|
1167
1352
|
"additionalProperties": {
|
|
1168
|
-
"type":
|
|
1353
|
+
"type": [
|
|
1354
|
+
"string",
|
|
1355
|
+
"number"
|
|
1356
|
+
]
|
|
1169
1357
|
}
|
|
1170
1358
|
},
|
|
1171
1359
|
"handleFailure": {
|
|
@@ -1181,7 +1369,10 @@
|
|
|
1181
1369
|
"type": "object",
|
|
1182
1370
|
"description": "The json object with response fields of the call to getDevice",
|
|
1183
1371
|
"additionalProperties": {
|
|
1184
|
-
"type":
|
|
1372
|
+
"type": [
|
|
1373
|
+
"string",
|
|
1374
|
+
"number"
|
|
1375
|
+
]
|
|
1185
1376
|
},
|
|
1186
1377
|
"properties": {}
|
|
1187
1378
|
},
|
|
@@ -1194,7 +1385,10 @@
|
|
|
1194
1385
|
"type": "object",
|
|
1195
1386
|
"description": "The json object with response fields of the call to getConfig",
|
|
1196
1387
|
"additionalProperties": {
|
|
1197
|
-
"type":
|
|
1388
|
+
"type": [
|
|
1389
|
+
"string",
|
|
1390
|
+
"number"
|
|
1391
|
+
]
|
|
1198
1392
|
},
|
|
1199
1393
|
"properties": {}
|
|
1200
1394
|
}
|
|
@@ -1205,6 +1399,7 @@
|
|
|
1205
1399
|
"type": "array",
|
|
1206
1400
|
"description": "Broker call(s) to getCount",
|
|
1207
1401
|
"items": {
|
|
1402
|
+
"type": "object",
|
|
1208
1403
|
"properties": {
|
|
1209
1404
|
"path": {
|
|
1210
1405
|
"type": "string",
|
|
@@ -1220,21 +1415,30 @@
|
|
|
1220
1415
|
"type": "object",
|
|
1221
1416
|
"description": "The json object with query parameters of the call to getCount",
|
|
1222
1417
|
"additionalProperties": {
|
|
1223
|
-
"type":
|
|
1418
|
+
"type": [
|
|
1419
|
+
"string",
|
|
1420
|
+
"number"
|
|
1421
|
+
]
|
|
1224
1422
|
}
|
|
1225
1423
|
},
|
|
1226
1424
|
"body": {
|
|
1227
1425
|
"type": "object",
|
|
1228
1426
|
"description": "The json object with body of the call to getCount",
|
|
1229
1427
|
"additionalProperties": {
|
|
1230
|
-
"type":
|
|
1428
|
+
"type": [
|
|
1429
|
+
"string",
|
|
1430
|
+
"number"
|
|
1431
|
+
]
|
|
1231
1432
|
}
|
|
1232
1433
|
},
|
|
1233
1434
|
"headers": {
|
|
1234
1435
|
"type": "object",
|
|
1235
1436
|
"description": "The json object with headers of the call to getCount",
|
|
1236
1437
|
"additionalProperties": {
|
|
1237
|
-
"type":
|
|
1438
|
+
"type": [
|
|
1439
|
+
"string",
|
|
1440
|
+
"number"
|
|
1441
|
+
]
|
|
1238
1442
|
}
|
|
1239
1443
|
},
|
|
1240
1444
|
"handleFailure": {
|
|
@@ -1250,7 +1454,10 @@
|
|
|
1250
1454
|
"type": "object",
|
|
1251
1455
|
"description": "The json object with response fields of the call to getDevice",
|
|
1252
1456
|
"additionalProperties": {
|
|
1253
|
-
"type":
|
|
1457
|
+
"type": [
|
|
1458
|
+
"string",
|
|
1459
|
+
"number"
|
|
1460
|
+
]
|
|
1254
1461
|
},
|
|
1255
1462
|
"properties": {}
|
|
1256
1463
|
},
|
|
@@ -1263,7 +1470,10 @@
|
|
|
1263
1470
|
"type": "object",
|
|
1264
1471
|
"description": "The json object with response fields of the call to getConfig",
|
|
1265
1472
|
"additionalProperties": {
|
|
1266
|
-
"type":
|
|
1473
|
+
"type": [
|
|
1474
|
+
"string",
|
|
1475
|
+
"number"
|
|
1476
|
+
]
|
|
1267
1477
|
},
|
|
1268
1478
|
"properties": {}
|
|
1269
1479
|
}
|
|
@@ -1271,6 +1481,196 @@
|
|
|
1271
1481
|
}
|
|
1272
1482
|
}
|
|
1273
1483
|
}
|
|
1484
|
+
},
|
|
1485
|
+
"cache": {
|
|
1486
|
+
"type": "object",
|
|
1487
|
+
"properties": {
|
|
1488
|
+
"enabled": {
|
|
1489
|
+
"type": "boolean",
|
|
1490
|
+
"description": "Whether or not cache is enabled for adapter",
|
|
1491
|
+
"default": false
|
|
1492
|
+
},
|
|
1493
|
+
"entities": {
|
|
1494
|
+
"type": "array",
|
|
1495
|
+
"description": "Information for the cached entities",
|
|
1496
|
+
"items": {
|
|
1497
|
+
"type": "object",
|
|
1498
|
+
"properties": {
|
|
1499
|
+
"entityType": {
|
|
1500
|
+
"type": "string",
|
|
1501
|
+
"description": "The name of the entity - should match adapter entity configuration or a broker (e.g. Device)",
|
|
1502
|
+
"default": ""
|
|
1503
|
+
},
|
|
1504
|
+
"frequency": {
|
|
1505
|
+
"type": "integer",
|
|
1506
|
+
"description": "how long (in minutes) we wait to re-populate the cache",
|
|
1507
|
+
"default": 1440,
|
|
1508
|
+
"maximum": 10080
|
|
1509
|
+
},
|
|
1510
|
+
"flushOnFail": {
|
|
1511
|
+
"type": "boolean",
|
|
1512
|
+
"description": "Whether to clear the cache we have if the populate failed",
|
|
1513
|
+
"default": false
|
|
1514
|
+
},
|
|
1515
|
+
"limit": {
|
|
1516
|
+
"type": "integer",
|
|
1517
|
+
"description": "maximum number of items to keep in cache",
|
|
1518
|
+
"default": 1000
|
|
1519
|
+
},
|
|
1520
|
+
"retryAttempts": {
|
|
1521
|
+
"type": "integer",
|
|
1522
|
+
"description": "number of times to retry the populate call before failure",
|
|
1523
|
+
"default": 5
|
|
1524
|
+
},
|
|
1525
|
+
"sort": {
|
|
1526
|
+
"type": "boolean",
|
|
1527
|
+
"description": "whether to sort the data or not",
|
|
1528
|
+
"default": true
|
|
1529
|
+
},
|
|
1530
|
+
"populate": {
|
|
1531
|
+
"type": "array",
|
|
1532
|
+
"description": "Information for the call(s) used to populate the cache",
|
|
1533
|
+
"items": {
|
|
1534
|
+
"type": "object",
|
|
1535
|
+
"properties": {
|
|
1536
|
+
"path": {
|
|
1537
|
+
"type": "string",
|
|
1538
|
+
"description": "The fully qualified path of the call to getDevice (e.g. /rest/api/device/{deviceid})",
|
|
1539
|
+
"default": ""
|
|
1540
|
+
},
|
|
1541
|
+
"method": {
|
|
1542
|
+
"type": "string",
|
|
1543
|
+
"description": "The method of the call to getDevice",
|
|
1544
|
+
"default": "GET"
|
|
1545
|
+
},
|
|
1546
|
+
"pagination": {
|
|
1547
|
+
"type": "object",
|
|
1548
|
+
"description": "todo",
|
|
1549
|
+
"properties": {
|
|
1550
|
+
"offsetVar": {
|
|
1551
|
+
"type": "string",
|
|
1552
|
+
"description": "Name of variable that defines how to go to next set of results"
|
|
1553
|
+
},
|
|
1554
|
+
"limitVar": {
|
|
1555
|
+
"type": "string",
|
|
1556
|
+
"description": "Name of variable that defines the max results returned in a request"
|
|
1557
|
+
},
|
|
1558
|
+
"incrementBy": {
|
|
1559
|
+
"type": "string",
|
|
1560
|
+
"enum": [
|
|
1561
|
+
"limit",
|
|
1562
|
+
"page"
|
|
1563
|
+
],
|
|
1564
|
+
"description": "How to incremenet offset. Default limit",
|
|
1565
|
+
"default": "limit"
|
|
1566
|
+
},
|
|
1567
|
+
"requestLocation": {
|
|
1568
|
+
"type": "string",
|
|
1569
|
+
"enum": [
|
|
1570
|
+
"query",
|
|
1571
|
+
"body"
|
|
1572
|
+
],
|
|
1573
|
+
"description": "Where in request the pagination data goes",
|
|
1574
|
+
"default": "query"
|
|
1575
|
+
}
|
|
1576
|
+
}
|
|
1577
|
+
},
|
|
1578
|
+
"query": {
|
|
1579
|
+
"type": "object",
|
|
1580
|
+
"description": "The json object with query parameters of the call to getDevice",
|
|
1581
|
+
"additionalProperties": {
|
|
1582
|
+
"type": [
|
|
1583
|
+
"string",
|
|
1584
|
+
"number"
|
|
1585
|
+
]
|
|
1586
|
+
}
|
|
1587
|
+
},
|
|
1588
|
+
"body": {
|
|
1589
|
+
"type": "object",
|
|
1590
|
+
"description": "The json object with body of the call to getDevice",
|
|
1591
|
+
"additionalProperties": {
|
|
1592
|
+
"type": [
|
|
1593
|
+
"string",
|
|
1594
|
+
"number"
|
|
1595
|
+
]
|
|
1596
|
+
}
|
|
1597
|
+
},
|
|
1598
|
+
"headers": {
|
|
1599
|
+
"type": "object",
|
|
1600
|
+
"description": "The json object with headers of the call to getDevice",
|
|
1601
|
+
"additionalProperties": {
|
|
1602
|
+
"type": [
|
|
1603
|
+
"string",
|
|
1604
|
+
"number"
|
|
1605
|
+
]
|
|
1606
|
+
}
|
|
1607
|
+
},
|
|
1608
|
+
"handleFailure": {
|
|
1609
|
+
"type": "string",
|
|
1610
|
+
"enum": [
|
|
1611
|
+
"ignore",
|
|
1612
|
+
"fail"
|
|
1613
|
+
],
|
|
1614
|
+
"description": "return failure or ignore failure",
|
|
1615
|
+
"default": "ignore"
|
|
1616
|
+
},
|
|
1617
|
+
"requestFields": {
|
|
1618
|
+
"type": "object",
|
|
1619
|
+
"description": "The json object with response fields of the call to getDevice",
|
|
1620
|
+
"additionalProperties": {
|
|
1621
|
+
"type": [
|
|
1622
|
+
"string",
|
|
1623
|
+
"number"
|
|
1624
|
+
]
|
|
1625
|
+
},
|
|
1626
|
+
"properties": {}
|
|
1627
|
+
},
|
|
1628
|
+
"responseDatakey": {
|
|
1629
|
+
"type": "string",
|
|
1630
|
+
"description": "place in the response where the data is - supports jsonquery",
|
|
1631
|
+
"default": ""
|
|
1632
|
+
},
|
|
1633
|
+
"responseFields": {
|
|
1634
|
+
"type": "object",
|
|
1635
|
+
"description": "The json object with response fields of the call to getDevice",
|
|
1636
|
+
"additionalProperties": {
|
|
1637
|
+
"type": [
|
|
1638
|
+
"string",
|
|
1639
|
+
"number"
|
|
1640
|
+
]
|
|
1641
|
+
}
|
|
1642
|
+
}
|
|
1643
|
+
}
|
|
1644
|
+
}
|
|
1645
|
+
},
|
|
1646
|
+
"cachedTasks": {
|
|
1647
|
+
"type": "array",
|
|
1648
|
+
"description": "Information for the call(s) used to populate the cache",
|
|
1649
|
+
"items": {
|
|
1650
|
+
"type": "object",
|
|
1651
|
+
"properties": {
|
|
1652
|
+
"name": {
|
|
1653
|
+
"type": "string",
|
|
1654
|
+
"description": "the name of the task/action that should utilize cached information",
|
|
1655
|
+
"default": ""
|
|
1656
|
+
},
|
|
1657
|
+
"filterField": {
|
|
1658
|
+
"type": "string",
|
|
1659
|
+
"description": "the field that contains filter information for this call",
|
|
1660
|
+
"default": ""
|
|
1661
|
+
},
|
|
1662
|
+
"filterLoc": {
|
|
1663
|
+
"type": "string",
|
|
1664
|
+
"description": "the field that contains the location of the filter field",
|
|
1665
|
+
"default": ""
|
|
1666
|
+
}
|
|
1667
|
+
}
|
|
1668
|
+
}
|
|
1669
|
+
}
|
|
1670
|
+
}
|
|
1671
|
+
}
|
|
1672
|
+
}
|
|
1673
|
+
}
|
|
1274
1674
|
}
|
|
1275
1675
|
}
|
|
1276
1676
|
}
|