@itentialopensource/adapter-sevone 2.4.0 → 2.5.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 +1661 -22
- package/CHANGELOG.md +16 -0
- package/CONTRIBUTING.md +1 -160
- package/ENHANCE.md +2 -2
- package/README.md +32 -23
- package/adapter.js +158 -668
- package/adapterBase.js +549 -879
- package/changelogs/CHANGELOG.md +118 -0
- package/metadata.json +49 -0
- package/package.json +24 -24
- package/pronghorn.json +980 -641
- package/propertiesSchema.json +431 -31
- package/refs?service=git-upload-pack +0 -0
- package/report/adapter-openapi.json +26172 -0
- package/report/adapter-openapi.yaml +11817 -0
- package/report/adapterInfo.json +8 -8
- package/report/updateReport1691508994383.json +120 -0
- package/report/updateReport1692202309339.json +120 -0
- package/report/updateReport1692203396464.json +120 -0
- package/report/updateReport1694470055393.json +120 -0
- package/report/updateReport1698423190930.json +120 -0
- package/sampleProperties.json +63 -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 +384 -158
- 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
|
@@ -41,6 +41,11 @@
|
|
|
41
41
|
"minimum": 1,
|
|
42
42
|
"maximum": 65535
|
|
43
43
|
},
|
|
44
|
+
"choosepath": {
|
|
45
|
+
"type": "string",
|
|
46
|
+
"description": "choose the path to use -- requires entityPath choices",
|
|
47
|
+
"default": ""
|
|
48
|
+
},
|
|
44
49
|
"base_path": {
|
|
45
50
|
"type": "string",
|
|
46
51
|
"description": "a base path that is consistent across api calls",
|
|
@@ -101,6 +106,14 @@
|
|
|
101
106
|
"https"
|
|
102
107
|
]
|
|
103
108
|
},
|
|
109
|
+
"service": {
|
|
110
|
+
"type": "string",
|
|
111
|
+
"description": "Service we are integrating with -- used with AWS Authentication",
|
|
112
|
+
"examples": [
|
|
113
|
+
"ec2",
|
|
114
|
+
"route53"
|
|
115
|
+
]
|
|
116
|
+
},
|
|
104
117
|
"authentication": {
|
|
105
118
|
"$ref": "#/definitions/authentication"
|
|
106
119
|
},
|
|
@@ -124,6 +137,9 @@
|
|
|
124
137
|
},
|
|
125
138
|
"devicebroker": {
|
|
126
139
|
"$ref": "#/definitions/devicebroker"
|
|
140
|
+
},
|
|
141
|
+
"cache": {
|
|
142
|
+
"$ref": "#/definitions/cache"
|
|
127
143
|
}
|
|
128
144
|
},
|
|
129
145
|
"required": [
|
|
@@ -145,7 +161,9 @@
|
|
|
145
161
|
"static_token",
|
|
146
162
|
"jwt_token",
|
|
147
163
|
"request_token",
|
|
148
|
-
"no_authentication"
|
|
164
|
+
"no_authentication",
|
|
165
|
+
"multi_step_authentication",
|
|
166
|
+
"aws_authentication"
|
|
149
167
|
]
|
|
150
168
|
},
|
|
151
169
|
"username": {
|
|
@@ -278,6 +296,74 @@
|
|
|
278
296
|
"type": "string",
|
|
279
297
|
"description": "The grant type for OAuth requests - can also provide in schema",
|
|
280
298
|
"default": ""
|
|
299
|
+
},
|
|
300
|
+
"sensitive": {
|
|
301
|
+
"type": "array",
|
|
302
|
+
"description": "List of sensitive keys to search and hide values from being logged",
|
|
303
|
+
"default": [],
|
|
304
|
+
"items": {
|
|
305
|
+
"type": "string"
|
|
306
|
+
}
|
|
307
|
+
},
|
|
308
|
+
"sso": {
|
|
309
|
+
"type": "object",
|
|
310
|
+
"properties": {
|
|
311
|
+
"protocol": {
|
|
312
|
+
"type": "string",
|
|
313
|
+
"description": "the protocol to request token from system",
|
|
314
|
+
"default": "",
|
|
315
|
+
"enum": [
|
|
316
|
+
"http",
|
|
317
|
+
"https",
|
|
318
|
+
""
|
|
319
|
+
]
|
|
320
|
+
},
|
|
321
|
+
"host": {
|
|
322
|
+
"type": "string",
|
|
323
|
+
"description": "hostname of the authentication system",
|
|
324
|
+
"default": "",
|
|
325
|
+
"examples": [
|
|
326
|
+
"systemx.customer.com"
|
|
327
|
+
]
|
|
328
|
+
},
|
|
329
|
+
"port": {
|
|
330
|
+
"type": "integer",
|
|
331
|
+
"description": "port on which to connect to the authentication system",
|
|
332
|
+
"default": 0,
|
|
333
|
+
"minimum": 0,
|
|
334
|
+
"maximum": 65535
|
|
335
|
+
}
|
|
336
|
+
}
|
|
337
|
+
},
|
|
338
|
+
"multiStepAuthCalls": {
|
|
339
|
+
"type": "array",
|
|
340
|
+
"items": {
|
|
341
|
+
"type": "object",
|
|
342
|
+
"properties": {
|
|
343
|
+
"name": {
|
|
344
|
+
"type": "string",
|
|
345
|
+
"description": "Id of the step call",
|
|
346
|
+
"examples": [
|
|
347
|
+
"getAccessToken"
|
|
348
|
+
]
|
|
349
|
+
},
|
|
350
|
+
"requestFields": {
|
|
351
|
+
"type": "object",
|
|
352
|
+
"description": "The fields set in step request"
|
|
353
|
+
},
|
|
354
|
+
"responseFields": {
|
|
355
|
+
"type": "object",
|
|
356
|
+
"description": "The fields from the step result"
|
|
357
|
+
},
|
|
358
|
+
"successfullResponseCode": {
|
|
359
|
+
"type": "integer",
|
|
360
|
+
"description": "Expected response code for given step, if not set any successfull http response is accepted",
|
|
361
|
+
"examples": [
|
|
362
|
+
200
|
|
363
|
+
]
|
|
364
|
+
}
|
|
365
|
+
}
|
|
366
|
+
}
|
|
281
367
|
}
|
|
282
368
|
},
|
|
283
369
|
"required": [
|
|
@@ -380,7 +466,13 @@
|
|
|
380
466
|
},
|
|
381
467
|
"query_object": {
|
|
382
468
|
"type": "object",
|
|
383
|
-
"description": "Query object { device: xxxxx } to be placed into the healthcheck, will be converted to query string by the adapter"
|
|
469
|
+
"description": "Query object { device: xxxxx } to be placed into the healthcheck, will be converted to query string by the adapter",
|
|
470
|
+
"default": {}
|
|
471
|
+
},
|
|
472
|
+
"addlHeaders": {
|
|
473
|
+
"type": "object",
|
|
474
|
+
"description": "headers that will be appended to the headers for the call",
|
|
475
|
+
"default": {}
|
|
384
476
|
}
|
|
385
477
|
},
|
|
386
478
|
"required": [
|
|
@@ -460,6 +552,7 @@
|
|
|
460
552
|
"priorities": {
|
|
461
553
|
"type": "array",
|
|
462
554
|
"description": "define your priorities here",
|
|
555
|
+
"default": [],
|
|
463
556
|
"items": {
|
|
464
557
|
"type": "object",
|
|
465
558
|
"properties": {
|
|
@@ -530,6 +623,7 @@
|
|
|
530
623
|
"failover_codes": {
|
|
531
624
|
"type": "array",
|
|
532
625
|
"description": "An array of codes where it is ok to try another method",
|
|
626
|
+
"default": [],
|
|
533
627
|
"items": {
|
|
534
628
|
"type": "integer"
|
|
535
629
|
}
|
|
@@ -547,19 +641,23 @@
|
|
|
547
641
|
"properties": {
|
|
548
642
|
"payload": {
|
|
549
643
|
"type": "object",
|
|
550
|
-
"description": "payload fields that will be appended to the provided payload (excluding GET calls)"
|
|
644
|
+
"description": "payload fields that will be appended to the provided payload (excluding GET calls)",
|
|
645
|
+
"default": {}
|
|
551
646
|
},
|
|
552
647
|
"uriOptions": {
|
|
553
648
|
"type": "object",
|
|
554
|
-
"description": "options that will be appended to all GET calls"
|
|
649
|
+
"description": "options that will be appended to all GET calls",
|
|
650
|
+
"default": {}
|
|
555
651
|
},
|
|
556
652
|
"addlHeaders": {
|
|
557
653
|
"type": "object",
|
|
558
|
-
"description": "headers that will be appended to the headers for the call"
|
|
654
|
+
"description": "headers that will be appended to the headers for the call",
|
|
655
|
+
"default": {}
|
|
559
656
|
},
|
|
560
657
|
"authData": {
|
|
561
658
|
"type": "object",
|
|
562
|
-
"description": "authentication data that will be appended to the payload for authentication calls"
|
|
659
|
+
"description": "authentication data that will be appended to the payload for authentication calls",
|
|
660
|
+
"default": {}
|
|
563
661
|
}
|
|
564
662
|
}
|
|
565
663
|
},
|
|
@@ -874,6 +972,7 @@
|
|
|
874
972
|
"type": "array",
|
|
875
973
|
"description": "Broker call(s) to getDevice",
|
|
876
974
|
"items": {
|
|
975
|
+
"type": "object",
|
|
877
976
|
"properties": {
|
|
878
977
|
"path": {
|
|
879
978
|
"type": "string",
|
|
@@ -889,21 +988,30 @@
|
|
|
889
988
|
"type": "object",
|
|
890
989
|
"description": "The json object with query parameters of the call to getDevice",
|
|
891
990
|
"additionalProperties": {
|
|
892
|
-
"type":
|
|
991
|
+
"type": [
|
|
992
|
+
"string",
|
|
993
|
+
"number"
|
|
994
|
+
]
|
|
893
995
|
}
|
|
894
996
|
},
|
|
895
997
|
"body": {
|
|
896
998
|
"type": "object",
|
|
897
999
|
"description": "The json object with body of the call to getDevice",
|
|
898
1000
|
"additionalProperties": {
|
|
899
|
-
"type":
|
|
1001
|
+
"type": [
|
|
1002
|
+
"string",
|
|
1003
|
+
"number"
|
|
1004
|
+
]
|
|
900
1005
|
}
|
|
901
1006
|
},
|
|
902
1007
|
"headers": {
|
|
903
1008
|
"type": "object",
|
|
904
1009
|
"description": "The json object with headers of the call to getDevice",
|
|
905
1010
|
"additionalProperties": {
|
|
906
|
-
"type":
|
|
1011
|
+
"type": [
|
|
1012
|
+
"string",
|
|
1013
|
+
"number"
|
|
1014
|
+
]
|
|
907
1015
|
}
|
|
908
1016
|
},
|
|
909
1017
|
"handleFailure": {
|
|
@@ -919,7 +1027,10 @@
|
|
|
919
1027
|
"type": "object",
|
|
920
1028
|
"description": "The json object with response fields of the call to getDevice",
|
|
921
1029
|
"additionalProperties": {
|
|
922
|
-
"type":
|
|
1030
|
+
"type": [
|
|
1031
|
+
"string",
|
|
1032
|
+
"number"
|
|
1033
|
+
]
|
|
923
1034
|
},
|
|
924
1035
|
"properties": {}
|
|
925
1036
|
},
|
|
@@ -932,7 +1043,10 @@
|
|
|
932
1043
|
"type": "object",
|
|
933
1044
|
"description": "The json object with response fields of the call to getDevice",
|
|
934
1045
|
"additionalProperties": {
|
|
935
|
-
"type":
|
|
1046
|
+
"type": [
|
|
1047
|
+
"string",
|
|
1048
|
+
"number"
|
|
1049
|
+
]
|
|
936
1050
|
},
|
|
937
1051
|
"properties": {
|
|
938
1052
|
"name": {
|
|
@@ -969,6 +1083,7 @@
|
|
|
969
1083
|
"type": "array",
|
|
970
1084
|
"description": "Broker call(s) to getDevicesFiltered",
|
|
971
1085
|
"items": {
|
|
1086
|
+
"type": "object",
|
|
972
1087
|
"properties": {
|
|
973
1088
|
"path": {
|
|
974
1089
|
"type": "string",
|
|
@@ -980,25 +1095,66 @@
|
|
|
980
1095
|
"description": "The method of the call to getDevicesFiltered",
|
|
981
1096
|
"default": "GET"
|
|
982
1097
|
},
|
|
1098
|
+
"pagination": {
|
|
1099
|
+
"type": "object",
|
|
1100
|
+
"description": "todo",
|
|
1101
|
+
"properties": {
|
|
1102
|
+
"offsetVar": {
|
|
1103
|
+
"type": "string",
|
|
1104
|
+
"description": "Name of variable that defines how to go to next set of results"
|
|
1105
|
+
},
|
|
1106
|
+
"limitVar": {
|
|
1107
|
+
"type": "string",
|
|
1108
|
+
"description": "Name of variable that defines the max results returned in a request"
|
|
1109
|
+
},
|
|
1110
|
+
"incrementBy": {
|
|
1111
|
+
"type": "string",
|
|
1112
|
+
"enum": [
|
|
1113
|
+
"limit",
|
|
1114
|
+
"page"
|
|
1115
|
+
],
|
|
1116
|
+
"description": "How to incremenet offset. Default limit",
|
|
1117
|
+
"default": "limit"
|
|
1118
|
+
},
|
|
1119
|
+
"requestLocation": {
|
|
1120
|
+
"type": "string",
|
|
1121
|
+
"enum": [
|
|
1122
|
+
"query",
|
|
1123
|
+
"body"
|
|
1124
|
+
],
|
|
1125
|
+
"description": "Where in request the pagination data goes",
|
|
1126
|
+
"default": "query"
|
|
1127
|
+
}
|
|
1128
|
+
}
|
|
1129
|
+
},
|
|
983
1130
|
"query": {
|
|
984
1131
|
"type": "object",
|
|
985
1132
|
"description": "The json object with query parameters of the call to getDevicesFiltered",
|
|
986
1133
|
"additionalProperties": {
|
|
987
|
-
"type":
|
|
1134
|
+
"type": [
|
|
1135
|
+
"string",
|
|
1136
|
+
"number"
|
|
1137
|
+
]
|
|
988
1138
|
}
|
|
989
1139
|
},
|
|
990
1140
|
"body": {
|
|
991
1141
|
"type": "object",
|
|
992
1142
|
"description": "The json object with body of the call to getDevicesFiltered",
|
|
993
1143
|
"additionalProperties": {
|
|
994
|
-
"type":
|
|
1144
|
+
"type": [
|
|
1145
|
+
"string",
|
|
1146
|
+
"number"
|
|
1147
|
+
]
|
|
995
1148
|
}
|
|
996
1149
|
},
|
|
997
1150
|
"headers": {
|
|
998
1151
|
"type": "object",
|
|
999
1152
|
"description": "The json object with headers of the call to getDevicesFiltered",
|
|
1000
1153
|
"additionalProperties": {
|
|
1001
|
-
"type":
|
|
1154
|
+
"type": [
|
|
1155
|
+
"string",
|
|
1156
|
+
"number"
|
|
1157
|
+
]
|
|
1002
1158
|
}
|
|
1003
1159
|
},
|
|
1004
1160
|
"handleFailure": {
|
|
@@ -1014,7 +1170,10 @@
|
|
|
1014
1170
|
"type": "object",
|
|
1015
1171
|
"description": "The json object with response fields of the call to getDevice",
|
|
1016
1172
|
"additionalProperties": {
|
|
1017
|
-
"type":
|
|
1173
|
+
"type": [
|
|
1174
|
+
"string",
|
|
1175
|
+
"number"
|
|
1176
|
+
]
|
|
1018
1177
|
},
|
|
1019
1178
|
"properties": {}
|
|
1020
1179
|
},
|
|
@@ -1027,7 +1186,10 @@
|
|
|
1027
1186
|
"type": "object",
|
|
1028
1187
|
"description": "The json object with response fields of the call to getDevicesFiltered",
|
|
1029
1188
|
"additionalProperties": {
|
|
1030
|
-
"type":
|
|
1189
|
+
"type": [
|
|
1190
|
+
"string",
|
|
1191
|
+
"number"
|
|
1192
|
+
]
|
|
1031
1193
|
},
|
|
1032
1194
|
"properties": {
|
|
1033
1195
|
"name": {
|
|
@@ -1064,6 +1226,7 @@
|
|
|
1064
1226
|
"type": "array",
|
|
1065
1227
|
"description": "Broker call(s) to determine if the device isAlive",
|
|
1066
1228
|
"items": {
|
|
1229
|
+
"type": "object",
|
|
1067
1230
|
"properties": {
|
|
1068
1231
|
"path": {
|
|
1069
1232
|
"type": "string",
|
|
@@ -1079,21 +1242,30 @@
|
|
|
1079
1242
|
"type": "object",
|
|
1080
1243
|
"description": "The json object with query parameters of the call to isAlive",
|
|
1081
1244
|
"additionalProperties": {
|
|
1082
|
-
"type":
|
|
1245
|
+
"type": [
|
|
1246
|
+
"string",
|
|
1247
|
+
"number"
|
|
1248
|
+
]
|
|
1083
1249
|
}
|
|
1084
1250
|
},
|
|
1085
1251
|
"body": {
|
|
1086
1252
|
"type": "object",
|
|
1087
1253
|
"description": "The json object with body of the call to isAlive",
|
|
1088
1254
|
"additionalProperties": {
|
|
1089
|
-
"type":
|
|
1255
|
+
"type": [
|
|
1256
|
+
"string",
|
|
1257
|
+
"number"
|
|
1258
|
+
]
|
|
1090
1259
|
}
|
|
1091
1260
|
},
|
|
1092
1261
|
"headers": {
|
|
1093
1262
|
"type": "object",
|
|
1094
1263
|
"description": "The json object with headers of the call to isAlive",
|
|
1095
1264
|
"additionalProperties": {
|
|
1096
|
-
"type":
|
|
1265
|
+
"type": [
|
|
1266
|
+
"string",
|
|
1267
|
+
"number"
|
|
1268
|
+
]
|
|
1097
1269
|
}
|
|
1098
1270
|
},
|
|
1099
1271
|
"handleFailure": {
|
|
@@ -1109,7 +1281,10 @@
|
|
|
1109
1281
|
"type": "object",
|
|
1110
1282
|
"description": "The json object with response fields of the call to getDevice",
|
|
1111
1283
|
"additionalProperties": {
|
|
1112
|
-
"type":
|
|
1284
|
+
"type": [
|
|
1285
|
+
"string",
|
|
1286
|
+
"number"
|
|
1287
|
+
]
|
|
1113
1288
|
},
|
|
1114
1289
|
"properties": {}
|
|
1115
1290
|
},
|
|
@@ -1122,7 +1297,10 @@
|
|
|
1122
1297
|
"type": "object",
|
|
1123
1298
|
"description": "The json object with response fields of the call to isAlive",
|
|
1124
1299
|
"additionalProperties": {
|
|
1125
|
-
"type":
|
|
1300
|
+
"type": [
|
|
1301
|
+
"string",
|
|
1302
|
+
"number"
|
|
1303
|
+
]
|
|
1126
1304
|
},
|
|
1127
1305
|
"properties": {
|
|
1128
1306
|
"status": {
|
|
@@ -1144,6 +1322,7 @@
|
|
|
1144
1322
|
"type": "array",
|
|
1145
1323
|
"description": "Broker call(s) to getConfig",
|
|
1146
1324
|
"items": {
|
|
1325
|
+
"type": "object",
|
|
1147
1326
|
"properties": {
|
|
1148
1327
|
"path": {
|
|
1149
1328
|
"type": "string",
|
|
@@ -1159,21 +1338,30 @@
|
|
|
1159
1338
|
"type": "object",
|
|
1160
1339
|
"description": "The json object with query parameters of the call to getConfig",
|
|
1161
1340
|
"additionalProperties": {
|
|
1162
|
-
"type":
|
|
1341
|
+
"type": [
|
|
1342
|
+
"string",
|
|
1343
|
+
"number"
|
|
1344
|
+
]
|
|
1163
1345
|
}
|
|
1164
1346
|
},
|
|
1165
1347
|
"body": {
|
|
1166
1348
|
"type": "object",
|
|
1167
1349
|
"description": "The json object with body of the call to getConfig",
|
|
1168
1350
|
"additionalProperties": {
|
|
1169
|
-
"type":
|
|
1351
|
+
"type": [
|
|
1352
|
+
"string",
|
|
1353
|
+
"number"
|
|
1354
|
+
]
|
|
1170
1355
|
}
|
|
1171
1356
|
},
|
|
1172
1357
|
"headers": {
|
|
1173
1358
|
"type": "object",
|
|
1174
1359
|
"description": "The json object with headers of the call to getConfig",
|
|
1175
1360
|
"additionalProperties": {
|
|
1176
|
-
"type":
|
|
1361
|
+
"type": [
|
|
1362
|
+
"string",
|
|
1363
|
+
"number"
|
|
1364
|
+
]
|
|
1177
1365
|
}
|
|
1178
1366
|
},
|
|
1179
1367
|
"handleFailure": {
|
|
@@ -1189,7 +1377,10 @@
|
|
|
1189
1377
|
"type": "object",
|
|
1190
1378
|
"description": "The json object with response fields of the call to getDevice",
|
|
1191
1379
|
"additionalProperties": {
|
|
1192
|
-
"type":
|
|
1380
|
+
"type": [
|
|
1381
|
+
"string",
|
|
1382
|
+
"number"
|
|
1383
|
+
]
|
|
1193
1384
|
},
|
|
1194
1385
|
"properties": {}
|
|
1195
1386
|
},
|
|
@@ -1202,7 +1393,10 @@
|
|
|
1202
1393
|
"type": "object",
|
|
1203
1394
|
"description": "The json object with response fields of the call to getConfig",
|
|
1204
1395
|
"additionalProperties": {
|
|
1205
|
-
"type":
|
|
1396
|
+
"type": [
|
|
1397
|
+
"string",
|
|
1398
|
+
"number"
|
|
1399
|
+
]
|
|
1206
1400
|
},
|
|
1207
1401
|
"properties": {}
|
|
1208
1402
|
}
|
|
@@ -1213,6 +1407,7 @@
|
|
|
1213
1407
|
"type": "array",
|
|
1214
1408
|
"description": "Broker call(s) to getCount",
|
|
1215
1409
|
"items": {
|
|
1410
|
+
"type": "object",
|
|
1216
1411
|
"properties": {
|
|
1217
1412
|
"path": {
|
|
1218
1413
|
"type": "string",
|
|
@@ -1228,21 +1423,30 @@
|
|
|
1228
1423
|
"type": "object",
|
|
1229
1424
|
"description": "The json object with query parameters of the call to getCount",
|
|
1230
1425
|
"additionalProperties": {
|
|
1231
|
-
"type":
|
|
1426
|
+
"type": [
|
|
1427
|
+
"string",
|
|
1428
|
+
"number"
|
|
1429
|
+
]
|
|
1232
1430
|
}
|
|
1233
1431
|
},
|
|
1234
1432
|
"body": {
|
|
1235
1433
|
"type": "object",
|
|
1236
1434
|
"description": "The json object with body of the call to getCount",
|
|
1237
1435
|
"additionalProperties": {
|
|
1238
|
-
"type":
|
|
1436
|
+
"type": [
|
|
1437
|
+
"string",
|
|
1438
|
+
"number"
|
|
1439
|
+
]
|
|
1239
1440
|
}
|
|
1240
1441
|
},
|
|
1241
1442
|
"headers": {
|
|
1242
1443
|
"type": "object",
|
|
1243
1444
|
"description": "The json object with headers of the call to getCount",
|
|
1244
1445
|
"additionalProperties": {
|
|
1245
|
-
"type":
|
|
1446
|
+
"type": [
|
|
1447
|
+
"string",
|
|
1448
|
+
"number"
|
|
1449
|
+
]
|
|
1246
1450
|
}
|
|
1247
1451
|
},
|
|
1248
1452
|
"handleFailure": {
|
|
@@ -1258,7 +1462,10 @@
|
|
|
1258
1462
|
"type": "object",
|
|
1259
1463
|
"description": "The json object with response fields of the call to getDevice",
|
|
1260
1464
|
"additionalProperties": {
|
|
1261
|
-
"type":
|
|
1465
|
+
"type": [
|
|
1466
|
+
"string",
|
|
1467
|
+
"number"
|
|
1468
|
+
]
|
|
1262
1469
|
},
|
|
1263
1470
|
"properties": {}
|
|
1264
1471
|
},
|
|
@@ -1271,7 +1478,10 @@
|
|
|
1271
1478
|
"type": "object",
|
|
1272
1479
|
"description": "The json object with response fields of the call to getConfig",
|
|
1273
1480
|
"additionalProperties": {
|
|
1274
|
-
"type":
|
|
1481
|
+
"type": [
|
|
1482
|
+
"string",
|
|
1483
|
+
"number"
|
|
1484
|
+
]
|
|
1275
1485
|
},
|
|
1276
1486
|
"properties": {}
|
|
1277
1487
|
}
|
|
@@ -1279,6 +1489,196 @@
|
|
|
1279
1489
|
}
|
|
1280
1490
|
}
|
|
1281
1491
|
}
|
|
1492
|
+
},
|
|
1493
|
+
"cache": {
|
|
1494
|
+
"type": "object",
|
|
1495
|
+
"properties": {
|
|
1496
|
+
"enabled": {
|
|
1497
|
+
"type": "boolean",
|
|
1498
|
+
"description": "Whether or not cache is enabled for adapter",
|
|
1499
|
+
"default": false
|
|
1500
|
+
},
|
|
1501
|
+
"entities": {
|
|
1502
|
+
"type": "array",
|
|
1503
|
+
"description": "Information for the cached entities",
|
|
1504
|
+
"items": {
|
|
1505
|
+
"type": "object",
|
|
1506
|
+
"properties": {
|
|
1507
|
+
"entityType": {
|
|
1508
|
+
"type": "string",
|
|
1509
|
+
"description": "The name of the entity - should match adapter entity configuration or a broker (e.g. Device)",
|
|
1510
|
+
"default": ""
|
|
1511
|
+
},
|
|
1512
|
+
"frequency": {
|
|
1513
|
+
"type": "integer",
|
|
1514
|
+
"description": "how long (in minutes) we wait to re-populate the cache",
|
|
1515
|
+
"default": 1440,
|
|
1516
|
+
"maximum": 10080
|
|
1517
|
+
},
|
|
1518
|
+
"flushOnFail": {
|
|
1519
|
+
"type": "boolean",
|
|
1520
|
+
"description": "Whether to clear the cache we have if the populate failed",
|
|
1521
|
+
"default": false
|
|
1522
|
+
},
|
|
1523
|
+
"limit": {
|
|
1524
|
+
"type": "integer",
|
|
1525
|
+
"description": "maximum number of items to keep in cache",
|
|
1526
|
+
"default": 1000
|
|
1527
|
+
},
|
|
1528
|
+
"retryAttempts": {
|
|
1529
|
+
"type": "integer",
|
|
1530
|
+
"description": "number of times to retry the populate call before failure",
|
|
1531
|
+
"default": 5
|
|
1532
|
+
},
|
|
1533
|
+
"sort": {
|
|
1534
|
+
"type": "boolean",
|
|
1535
|
+
"description": "whether to sort the data or not",
|
|
1536
|
+
"default": true
|
|
1537
|
+
},
|
|
1538
|
+
"populate": {
|
|
1539
|
+
"type": "array",
|
|
1540
|
+
"description": "Information for the call(s) used to populate the cache",
|
|
1541
|
+
"items": {
|
|
1542
|
+
"type": "object",
|
|
1543
|
+
"properties": {
|
|
1544
|
+
"path": {
|
|
1545
|
+
"type": "string",
|
|
1546
|
+
"description": "The fully qualified path of the call to getDevice (e.g. /rest/api/device/{deviceid})",
|
|
1547
|
+
"default": ""
|
|
1548
|
+
},
|
|
1549
|
+
"method": {
|
|
1550
|
+
"type": "string",
|
|
1551
|
+
"description": "The method of the call to getDevice",
|
|
1552
|
+
"default": "GET"
|
|
1553
|
+
},
|
|
1554
|
+
"pagination": {
|
|
1555
|
+
"type": "object",
|
|
1556
|
+
"description": "todo",
|
|
1557
|
+
"properties": {
|
|
1558
|
+
"offsetVar": {
|
|
1559
|
+
"type": "string",
|
|
1560
|
+
"description": "Name of variable that defines how to go to next set of results"
|
|
1561
|
+
},
|
|
1562
|
+
"limitVar": {
|
|
1563
|
+
"type": "string",
|
|
1564
|
+
"description": "Name of variable that defines the max results returned in a request"
|
|
1565
|
+
},
|
|
1566
|
+
"incrementBy": {
|
|
1567
|
+
"type": "string",
|
|
1568
|
+
"enum": [
|
|
1569
|
+
"limit",
|
|
1570
|
+
"page"
|
|
1571
|
+
],
|
|
1572
|
+
"description": "How to incremenet offset. Default limit",
|
|
1573
|
+
"default": "limit"
|
|
1574
|
+
},
|
|
1575
|
+
"requestLocation": {
|
|
1576
|
+
"type": "string",
|
|
1577
|
+
"enum": [
|
|
1578
|
+
"query",
|
|
1579
|
+
"body"
|
|
1580
|
+
],
|
|
1581
|
+
"description": "Where in request the pagination data goes",
|
|
1582
|
+
"default": "query"
|
|
1583
|
+
}
|
|
1584
|
+
}
|
|
1585
|
+
},
|
|
1586
|
+
"query": {
|
|
1587
|
+
"type": "object",
|
|
1588
|
+
"description": "The json object with query parameters of the call to getDevice",
|
|
1589
|
+
"additionalProperties": {
|
|
1590
|
+
"type": [
|
|
1591
|
+
"string",
|
|
1592
|
+
"number"
|
|
1593
|
+
]
|
|
1594
|
+
}
|
|
1595
|
+
},
|
|
1596
|
+
"body": {
|
|
1597
|
+
"type": "object",
|
|
1598
|
+
"description": "The json object with body of the call to getDevice",
|
|
1599
|
+
"additionalProperties": {
|
|
1600
|
+
"type": [
|
|
1601
|
+
"string",
|
|
1602
|
+
"number"
|
|
1603
|
+
]
|
|
1604
|
+
}
|
|
1605
|
+
},
|
|
1606
|
+
"headers": {
|
|
1607
|
+
"type": "object",
|
|
1608
|
+
"description": "The json object with headers of the call to getDevice",
|
|
1609
|
+
"additionalProperties": {
|
|
1610
|
+
"type": [
|
|
1611
|
+
"string",
|
|
1612
|
+
"number"
|
|
1613
|
+
]
|
|
1614
|
+
}
|
|
1615
|
+
},
|
|
1616
|
+
"handleFailure": {
|
|
1617
|
+
"type": "string",
|
|
1618
|
+
"enum": [
|
|
1619
|
+
"ignore",
|
|
1620
|
+
"fail"
|
|
1621
|
+
],
|
|
1622
|
+
"description": "return failure or ignore failure",
|
|
1623
|
+
"default": "ignore"
|
|
1624
|
+
},
|
|
1625
|
+
"requestFields": {
|
|
1626
|
+
"type": "object",
|
|
1627
|
+
"description": "The json object with response fields of the call to getDevice",
|
|
1628
|
+
"additionalProperties": {
|
|
1629
|
+
"type": [
|
|
1630
|
+
"string",
|
|
1631
|
+
"number"
|
|
1632
|
+
]
|
|
1633
|
+
},
|
|
1634
|
+
"properties": {}
|
|
1635
|
+
},
|
|
1636
|
+
"responseDatakey": {
|
|
1637
|
+
"type": "string",
|
|
1638
|
+
"description": "place in the response where the data is - supports jsonquery",
|
|
1639
|
+
"default": ""
|
|
1640
|
+
},
|
|
1641
|
+
"responseFields": {
|
|
1642
|
+
"type": "object",
|
|
1643
|
+
"description": "The json object with response fields of the call to getDevice",
|
|
1644
|
+
"additionalProperties": {
|
|
1645
|
+
"type": [
|
|
1646
|
+
"string",
|
|
1647
|
+
"number"
|
|
1648
|
+
]
|
|
1649
|
+
}
|
|
1650
|
+
}
|
|
1651
|
+
}
|
|
1652
|
+
}
|
|
1653
|
+
},
|
|
1654
|
+
"cachedTasks": {
|
|
1655
|
+
"type": "array",
|
|
1656
|
+
"description": "Information for the call(s) used to populate the cache",
|
|
1657
|
+
"items": {
|
|
1658
|
+
"type": "object",
|
|
1659
|
+
"properties": {
|
|
1660
|
+
"name": {
|
|
1661
|
+
"type": "string",
|
|
1662
|
+
"description": "the name of the task/action that should utilize cached information",
|
|
1663
|
+
"default": ""
|
|
1664
|
+
},
|
|
1665
|
+
"filterField": {
|
|
1666
|
+
"type": "string",
|
|
1667
|
+
"description": "the field that contains filter information for this call",
|
|
1668
|
+
"default": ""
|
|
1669
|
+
},
|
|
1670
|
+
"filterLoc": {
|
|
1671
|
+
"type": "string",
|
|
1672
|
+
"description": "the field that contains the location of the filter field",
|
|
1673
|
+
"default": ""
|
|
1674
|
+
}
|
|
1675
|
+
}
|
|
1676
|
+
}
|
|
1677
|
+
}
|
|
1678
|
+
}
|
|
1679
|
+
}
|
|
1680
|
+
}
|
|
1681
|
+
}
|
|
1282
1682
|
}
|
|
1283
1683
|
}
|
|
1284
1684
|
}
|