@itentialopensource/adapter-openstack_neutron 3.0.2 → 3.1.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/AUTH.md +9 -9
- package/CALLS.md +364 -328
- package/CHANGELOG.md +16 -0
- package/CONTRIBUTING.md +1 -160
- package/ENHANCE.md +2 -2
- package/README.md +32 -23
- package/adapter.js +174 -373
- package/adapterBase.js +517 -875
- package/changelogs/CHANGELOG.md +58 -0
- package/metadata.json +56 -0
- package/package.json +24 -26
- package/pronghorn.json +474 -142
- package/propertiesSchema.json +431 -34
- package/refs?service=git-upload-pack +0 -0
- package/report/adapter-openapi.json +14594 -0
- package/report/adapter-openapi.yaml +12289 -0
- package/report/adapterInfo.json +8 -8
- package/report/updateReport1691507382282.json +120 -0
- package/report/updateReport1692202417483.json +120 -0
- package/report/updateReport1694460523394.json +120 -0
- package/report/updateReport1698420447048.json +120 -0
- package/sampleProperties.json +58 -3
- 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 +389 -317
- package/test/unit/adapterTestUnit.js +303 -114
- 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 +71 -23
- package/utils/modify.js +13 -15
- package/utils/packModificationScript.js +1 -1
- 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": {
|
|
@@ -259,20 +277,85 @@
|
|
|
259
277
|
"os_user_domain_name": {
|
|
260
278
|
"type": "string",
|
|
261
279
|
"description": "User's owning domain name",
|
|
262
|
-
"minLength": 1,
|
|
263
280
|
"default": ""
|
|
264
281
|
},
|
|
265
282
|
"os_project_name": {
|
|
266
283
|
"type": "string",
|
|
267
284
|
"description": "Project name for authorization scope",
|
|
268
|
-
"minLength": 1,
|
|
269
285
|
"default": ""
|
|
270
286
|
},
|
|
271
287
|
"os_project_domain_name": {
|
|
272
288
|
"type": "string",
|
|
273
289
|
"description": "Project domain name for authorization scope",
|
|
274
|
-
"minLength": 1,
|
|
275
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
|
+
}
|
|
276
359
|
}
|
|
277
360
|
},
|
|
278
361
|
"required": [
|
|
@@ -380,7 +463,13 @@
|
|
|
380
463
|
},
|
|
381
464
|
"query_object": {
|
|
382
465
|
"type": "object",
|
|
383
|
-
"description": "Query object { device: xxxxx } to be placed into the healthcheck, will be converted to query string by the adapter"
|
|
466
|
+
"description": "Query object { device: xxxxx } to be placed into the healthcheck, will be converted to query string by the adapter",
|
|
467
|
+
"default": {}
|
|
468
|
+
},
|
|
469
|
+
"addlHeaders": {
|
|
470
|
+
"type": "object",
|
|
471
|
+
"description": "headers that will be appended to the headers for the call",
|
|
472
|
+
"default": {}
|
|
384
473
|
}
|
|
385
474
|
},
|
|
386
475
|
"required": [
|
|
@@ -460,6 +549,7 @@
|
|
|
460
549
|
"priorities": {
|
|
461
550
|
"type": "array",
|
|
462
551
|
"description": "define your priorities here",
|
|
552
|
+
"default": [],
|
|
463
553
|
"items": {
|
|
464
554
|
"type": "object",
|
|
465
555
|
"properties": {
|
|
@@ -530,6 +620,7 @@
|
|
|
530
620
|
"failover_codes": {
|
|
531
621
|
"type": "array",
|
|
532
622
|
"description": "An array of codes where it is ok to try another method",
|
|
623
|
+
"default": [],
|
|
533
624
|
"items": {
|
|
534
625
|
"type": "integer"
|
|
535
626
|
}
|
|
@@ -547,19 +638,23 @@
|
|
|
547
638
|
"properties": {
|
|
548
639
|
"payload": {
|
|
549
640
|
"type": "object",
|
|
550
|
-
"description": "payload fields that will be appended to the provided payload (excluding GET calls)"
|
|
641
|
+
"description": "payload fields that will be appended to the provided payload (excluding GET calls)",
|
|
642
|
+
"default": {}
|
|
551
643
|
},
|
|
552
644
|
"uriOptions": {
|
|
553
645
|
"type": "object",
|
|
554
|
-
"description": "options that will be appended to all GET calls"
|
|
646
|
+
"description": "options that will be appended to all GET calls",
|
|
647
|
+
"default": {}
|
|
555
648
|
},
|
|
556
649
|
"addlHeaders": {
|
|
557
650
|
"type": "object",
|
|
558
|
-
"description": "headers that will be appended to the headers for the call"
|
|
651
|
+
"description": "headers that will be appended to the headers for the call",
|
|
652
|
+
"default": {}
|
|
559
653
|
},
|
|
560
654
|
"authData": {
|
|
561
655
|
"type": "object",
|
|
562
|
-
"description": "authentication data that will be appended to the payload for authentication calls"
|
|
656
|
+
"description": "authentication data that will be appended to the payload for authentication calls",
|
|
657
|
+
"default": {}
|
|
563
658
|
}
|
|
564
659
|
}
|
|
565
660
|
},
|
|
@@ -874,6 +969,7 @@
|
|
|
874
969
|
"type": "array",
|
|
875
970
|
"description": "Broker call(s) to getDevice",
|
|
876
971
|
"items": {
|
|
972
|
+
"type": "object",
|
|
877
973
|
"properties": {
|
|
878
974
|
"path": {
|
|
879
975
|
"type": "string",
|
|
@@ -889,21 +985,30 @@
|
|
|
889
985
|
"type": "object",
|
|
890
986
|
"description": "The json object with query parameters of the call to getDevice",
|
|
891
987
|
"additionalProperties": {
|
|
892
|
-
"type":
|
|
988
|
+
"type": [
|
|
989
|
+
"string",
|
|
990
|
+
"number"
|
|
991
|
+
]
|
|
893
992
|
}
|
|
894
993
|
},
|
|
895
994
|
"body": {
|
|
896
995
|
"type": "object",
|
|
897
996
|
"description": "The json object with body of the call to getDevice",
|
|
898
997
|
"additionalProperties": {
|
|
899
|
-
"type":
|
|
998
|
+
"type": [
|
|
999
|
+
"string",
|
|
1000
|
+
"number"
|
|
1001
|
+
]
|
|
900
1002
|
}
|
|
901
1003
|
},
|
|
902
1004
|
"headers": {
|
|
903
1005
|
"type": "object",
|
|
904
1006
|
"description": "The json object with headers of the call to getDevice",
|
|
905
1007
|
"additionalProperties": {
|
|
906
|
-
"type":
|
|
1008
|
+
"type": [
|
|
1009
|
+
"string",
|
|
1010
|
+
"number"
|
|
1011
|
+
]
|
|
907
1012
|
}
|
|
908
1013
|
},
|
|
909
1014
|
"handleFailure": {
|
|
@@ -919,7 +1024,10 @@
|
|
|
919
1024
|
"type": "object",
|
|
920
1025
|
"description": "The json object with response fields of the call to getDevice",
|
|
921
1026
|
"additionalProperties": {
|
|
922
|
-
"type":
|
|
1027
|
+
"type": [
|
|
1028
|
+
"string",
|
|
1029
|
+
"number"
|
|
1030
|
+
]
|
|
923
1031
|
},
|
|
924
1032
|
"properties": {}
|
|
925
1033
|
},
|
|
@@ -932,7 +1040,10 @@
|
|
|
932
1040
|
"type": "object",
|
|
933
1041
|
"description": "The json object with response fields of the call to getDevice",
|
|
934
1042
|
"additionalProperties": {
|
|
935
|
-
"type":
|
|
1043
|
+
"type": [
|
|
1044
|
+
"string",
|
|
1045
|
+
"number"
|
|
1046
|
+
]
|
|
936
1047
|
},
|
|
937
1048
|
"properties": {
|
|
938
1049
|
"name": {
|
|
@@ -969,6 +1080,7 @@
|
|
|
969
1080
|
"type": "array",
|
|
970
1081
|
"description": "Broker call(s) to getDevicesFiltered",
|
|
971
1082
|
"items": {
|
|
1083
|
+
"type": "object",
|
|
972
1084
|
"properties": {
|
|
973
1085
|
"path": {
|
|
974
1086
|
"type": "string",
|
|
@@ -980,25 +1092,66 @@
|
|
|
980
1092
|
"description": "The method of the call to getDevicesFiltered",
|
|
981
1093
|
"default": "GET"
|
|
982
1094
|
},
|
|
1095
|
+
"pagination": {
|
|
1096
|
+
"type": "object",
|
|
1097
|
+
"description": "todo",
|
|
1098
|
+
"properties": {
|
|
1099
|
+
"offsetVar": {
|
|
1100
|
+
"type": "string",
|
|
1101
|
+
"description": "Name of variable that defines how to go to next set of results"
|
|
1102
|
+
},
|
|
1103
|
+
"limitVar": {
|
|
1104
|
+
"type": "string",
|
|
1105
|
+
"description": "Name of variable that defines the max results returned in a request"
|
|
1106
|
+
},
|
|
1107
|
+
"incrementBy": {
|
|
1108
|
+
"type": "string",
|
|
1109
|
+
"enum": [
|
|
1110
|
+
"limit",
|
|
1111
|
+
"page"
|
|
1112
|
+
],
|
|
1113
|
+
"description": "How to incremenet offset. Default limit",
|
|
1114
|
+
"default": "limit"
|
|
1115
|
+
},
|
|
1116
|
+
"requestLocation": {
|
|
1117
|
+
"type": "string",
|
|
1118
|
+
"enum": [
|
|
1119
|
+
"query",
|
|
1120
|
+
"body"
|
|
1121
|
+
],
|
|
1122
|
+
"description": "Where in request the pagination data goes",
|
|
1123
|
+
"default": "query"
|
|
1124
|
+
}
|
|
1125
|
+
}
|
|
1126
|
+
},
|
|
983
1127
|
"query": {
|
|
984
1128
|
"type": "object",
|
|
985
1129
|
"description": "The json object with query parameters of the call to getDevicesFiltered",
|
|
986
1130
|
"additionalProperties": {
|
|
987
|
-
"type":
|
|
1131
|
+
"type": [
|
|
1132
|
+
"string",
|
|
1133
|
+
"number"
|
|
1134
|
+
]
|
|
988
1135
|
}
|
|
989
1136
|
},
|
|
990
1137
|
"body": {
|
|
991
1138
|
"type": "object",
|
|
992
1139
|
"description": "The json object with body of the call to getDevicesFiltered",
|
|
993
1140
|
"additionalProperties": {
|
|
994
|
-
"type":
|
|
1141
|
+
"type": [
|
|
1142
|
+
"string",
|
|
1143
|
+
"number"
|
|
1144
|
+
]
|
|
995
1145
|
}
|
|
996
1146
|
},
|
|
997
1147
|
"headers": {
|
|
998
1148
|
"type": "object",
|
|
999
1149
|
"description": "The json object with headers of the call to getDevicesFiltered",
|
|
1000
1150
|
"additionalProperties": {
|
|
1001
|
-
"type":
|
|
1151
|
+
"type": [
|
|
1152
|
+
"string",
|
|
1153
|
+
"number"
|
|
1154
|
+
]
|
|
1002
1155
|
}
|
|
1003
1156
|
},
|
|
1004
1157
|
"handleFailure": {
|
|
@@ -1014,7 +1167,10 @@
|
|
|
1014
1167
|
"type": "object",
|
|
1015
1168
|
"description": "The json object with response fields of the call to getDevice",
|
|
1016
1169
|
"additionalProperties": {
|
|
1017
|
-
"type":
|
|
1170
|
+
"type": [
|
|
1171
|
+
"string",
|
|
1172
|
+
"number"
|
|
1173
|
+
]
|
|
1018
1174
|
},
|
|
1019
1175
|
"properties": {}
|
|
1020
1176
|
},
|
|
@@ -1027,7 +1183,10 @@
|
|
|
1027
1183
|
"type": "object",
|
|
1028
1184
|
"description": "The json object with response fields of the call to getDevicesFiltered",
|
|
1029
1185
|
"additionalProperties": {
|
|
1030
|
-
"type":
|
|
1186
|
+
"type": [
|
|
1187
|
+
"string",
|
|
1188
|
+
"number"
|
|
1189
|
+
]
|
|
1031
1190
|
},
|
|
1032
1191
|
"properties": {
|
|
1033
1192
|
"name": {
|
|
@@ -1064,6 +1223,7 @@
|
|
|
1064
1223
|
"type": "array",
|
|
1065
1224
|
"description": "Broker call(s) to determine if the device isAlive",
|
|
1066
1225
|
"items": {
|
|
1226
|
+
"type": "object",
|
|
1067
1227
|
"properties": {
|
|
1068
1228
|
"path": {
|
|
1069
1229
|
"type": "string",
|
|
@@ -1079,21 +1239,30 @@
|
|
|
1079
1239
|
"type": "object",
|
|
1080
1240
|
"description": "The json object with query parameters of the call to isAlive",
|
|
1081
1241
|
"additionalProperties": {
|
|
1082
|
-
"type":
|
|
1242
|
+
"type": [
|
|
1243
|
+
"string",
|
|
1244
|
+
"number"
|
|
1245
|
+
]
|
|
1083
1246
|
}
|
|
1084
1247
|
},
|
|
1085
1248
|
"body": {
|
|
1086
1249
|
"type": "object",
|
|
1087
1250
|
"description": "The json object with body of the call to isAlive",
|
|
1088
1251
|
"additionalProperties": {
|
|
1089
|
-
"type":
|
|
1252
|
+
"type": [
|
|
1253
|
+
"string",
|
|
1254
|
+
"number"
|
|
1255
|
+
]
|
|
1090
1256
|
}
|
|
1091
1257
|
},
|
|
1092
1258
|
"headers": {
|
|
1093
1259
|
"type": "object",
|
|
1094
1260
|
"description": "The json object with headers of the call to isAlive",
|
|
1095
1261
|
"additionalProperties": {
|
|
1096
|
-
"type":
|
|
1262
|
+
"type": [
|
|
1263
|
+
"string",
|
|
1264
|
+
"number"
|
|
1265
|
+
]
|
|
1097
1266
|
}
|
|
1098
1267
|
},
|
|
1099
1268
|
"handleFailure": {
|
|
@@ -1109,7 +1278,10 @@
|
|
|
1109
1278
|
"type": "object",
|
|
1110
1279
|
"description": "The json object with response fields of the call to getDevice",
|
|
1111
1280
|
"additionalProperties": {
|
|
1112
|
-
"type":
|
|
1281
|
+
"type": [
|
|
1282
|
+
"string",
|
|
1283
|
+
"number"
|
|
1284
|
+
]
|
|
1113
1285
|
},
|
|
1114
1286
|
"properties": {}
|
|
1115
1287
|
},
|
|
@@ -1122,7 +1294,10 @@
|
|
|
1122
1294
|
"type": "object",
|
|
1123
1295
|
"description": "The json object with response fields of the call to isAlive",
|
|
1124
1296
|
"additionalProperties": {
|
|
1125
|
-
"type":
|
|
1297
|
+
"type": [
|
|
1298
|
+
"string",
|
|
1299
|
+
"number"
|
|
1300
|
+
]
|
|
1126
1301
|
},
|
|
1127
1302
|
"properties": {
|
|
1128
1303
|
"status": {
|
|
@@ -1144,6 +1319,7 @@
|
|
|
1144
1319
|
"type": "array",
|
|
1145
1320
|
"description": "Broker call(s) to getConfig",
|
|
1146
1321
|
"items": {
|
|
1322
|
+
"type": "object",
|
|
1147
1323
|
"properties": {
|
|
1148
1324
|
"path": {
|
|
1149
1325
|
"type": "string",
|
|
@@ -1159,21 +1335,30 @@
|
|
|
1159
1335
|
"type": "object",
|
|
1160
1336
|
"description": "The json object with query parameters of the call to getConfig",
|
|
1161
1337
|
"additionalProperties": {
|
|
1162
|
-
"type":
|
|
1338
|
+
"type": [
|
|
1339
|
+
"string",
|
|
1340
|
+
"number"
|
|
1341
|
+
]
|
|
1163
1342
|
}
|
|
1164
1343
|
},
|
|
1165
1344
|
"body": {
|
|
1166
1345
|
"type": "object",
|
|
1167
1346
|
"description": "The json object with body of the call to getConfig",
|
|
1168
1347
|
"additionalProperties": {
|
|
1169
|
-
"type":
|
|
1348
|
+
"type": [
|
|
1349
|
+
"string",
|
|
1350
|
+
"number"
|
|
1351
|
+
]
|
|
1170
1352
|
}
|
|
1171
1353
|
},
|
|
1172
1354
|
"headers": {
|
|
1173
1355
|
"type": "object",
|
|
1174
1356
|
"description": "The json object with headers of the call to getConfig",
|
|
1175
1357
|
"additionalProperties": {
|
|
1176
|
-
"type":
|
|
1358
|
+
"type": [
|
|
1359
|
+
"string",
|
|
1360
|
+
"number"
|
|
1361
|
+
]
|
|
1177
1362
|
}
|
|
1178
1363
|
},
|
|
1179
1364
|
"handleFailure": {
|
|
@@ -1189,7 +1374,10 @@
|
|
|
1189
1374
|
"type": "object",
|
|
1190
1375
|
"description": "The json object with response fields of the call to getDevice",
|
|
1191
1376
|
"additionalProperties": {
|
|
1192
|
-
"type":
|
|
1377
|
+
"type": [
|
|
1378
|
+
"string",
|
|
1379
|
+
"number"
|
|
1380
|
+
]
|
|
1193
1381
|
},
|
|
1194
1382
|
"properties": {}
|
|
1195
1383
|
},
|
|
@@ -1202,7 +1390,10 @@
|
|
|
1202
1390
|
"type": "object",
|
|
1203
1391
|
"description": "The json object with response fields of the call to getConfig",
|
|
1204
1392
|
"additionalProperties": {
|
|
1205
|
-
"type":
|
|
1393
|
+
"type": [
|
|
1394
|
+
"string",
|
|
1395
|
+
"number"
|
|
1396
|
+
]
|
|
1206
1397
|
},
|
|
1207
1398
|
"properties": {}
|
|
1208
1399
|
}
|
|
@@ -1213,6 +1404,7 @@
|
|
|
1213
1404
|
"type": "array",
|
|
1214
1405
|
"description": "Broker call(s) to getCount",
|
|
1215
1406
|
"items": {
|
|
1407
|
+
"type": "object",
|
|
1216
1408
|
"properties": {
|
|
1217
1409
|
"path": {
|
|
1218
1410
|
"type": "string",
|
|
@@ -1228,21 +1420,30 @@
|
|
|
1228
1420
|
"type": "object",
|
|
1229
1421
|
"description": "The json object with query parameters of the call to getCount",
|
|
1230
1422
|
"additionalProperties": {
|
|
1231
|
-
"type":
|
|
1423
|
+
"type": [
|
|
1424
|
+
"string",
|
|
1425
|
+
"number"
|
|
1426
|
+
]
|
|
1232
1427
|
}
|
|
1233
1428
|
},
|
|
1234
1429
|
"body": {
|
|
1235
1430
|
"type": "object",
|
|
1236
1431
|
"description": "The json object with body of the call to getCount",
|
|
1237
1432
|
"additionalProperties": {
|
|
1238
|
-
"type":
|
|
1433
|
+
"type": [
|
|
1434
|
+
"string",
|
|
1435
|
+
"number"
|
|
1436
|
+
]
|
|
1239
1437
|
}
|
|
1240
1438
|
},
|
|
1241
1439
|
"headers": {
|
|
1242
1440
|
"type": "object",
|
|
1243
1441
|
"description": "The json object with headers of the call to getCount",
|
|
1244
1442
|
"additionalProperties": {
|
|
1245
|
-
"type":
|
|
1443
|
+
"type": [
|
|
1444
|
+
"string",
|
|
1445
|
+
"number"
|
|
1446
|
+
]
|
|
1246
1447
|
}
|
|
1247
1448
|
},
|
|
1248
1449
|
"handleFailure": {
|
|
@@ -1258,7 +1459,10 @@
|
|
|
1258
1459
|
"type": "object",
|
|
1259
1460
|
"description": "The json object with response fields of the call to getDevice",
|
|
1260
1461
|
"additionalProperties": {
|
|
1261
|
-
"type":
|
|
1462
|
+
"type": [
|
|
1463
|
+
"string",
|
|
1464
|
+
"number"
|
|
1465
|
+
]
|
|
1262
1466
|
},
|
|
1263
1467
|
"properties": {}
|
|
1264
1468
|
},
|
|
@@ -1271,7 +1475,10 @@
|
|
|
1271
1475
|
"type": "object",
|
|
1272
1476
|
"description": "The json object with response fields of the call to getConfig",
|
|
1273
1477
|
"additionalProperties": {
|
|
1274
|
-
"type":
|
|
1478
|
+
"type": [
|
|
1479
|
+
"string",
|
|
1480
|
+
"number"
|
|
1481
|
+
]
|
|
1275
1482
|
},
|
|
1276
1483
|
"properties": {}
|
|
1277
1484
|
}
|
|
@@ -1279,6 +1486,196 @@
|
|
|
1279
1486
|
}
|
|
1280
1487
|
}
|
|
1281
1488
|
}
|
|
1489
|
+
},
|
|
1490
|
+
"cache": {
|
|
1491
|
+
"type": "object",
|
|
1492
|
+
"properties": {
|
|
1493
|
+
"enabled": {
|
|
1494
|
+
"type": "boolean",
|
|
1495
|
+
"description": "Whether or not cache is enabled for adapter",
|
|
1496
|
+
"default": false
|
|
1497
|
+
},
|
|
1498
|
+
"entities": {
|
|
1499
|
+
"type": "array",
|
|
1500
|
+
"description": "Information for the cached entities",
|
|
1501
|
+
"items": {
|
|
1502
|
+
"type": "object",
|
|
1503
|
+
"properties": {
|
|
1504
|
+
"entityType": {
|
|
1505
|
+
"type": "string",
|
|
1506
|
+
"description": "The name of the entity - should match adapter entity configuration or a broker (e.g. Device)",
|
|
1507
|
+
"default": ""
|
|
1508
|
+
},
|
|
1509
|
+
"frequency": {
|
|
1510
|
+
"type": "integer",
|
|
1511
|
+
"description": "how long (in minutes) we wait to re-populate the cache",
|
|
1512
|
+
"default": 1440,
|
|
1513
|
+
"maximum": 10080
|
|
1514
|
+
},
|
|
1515
|
+
"flushOnFail": {
|
|
1516
|
+
"type": "boolean",
|
|
1517
|
+
"description": "Whether to clear the cache we have if the populate failed",
|
|
1518
|
+
"default": false
|
|
1519
|
+
},
|
|
1520
|
+
"limit": {
|
|
1521
|
+
"type": "integer",
|
|
1522
|
+
"description": "maximum number of items to keep in cache",
|
|
1523
|
+
"default": 1000
|
|
1524
|
+
},
|
|
1525
|
+
"retryAttempts": {
|
|
1526
|
+
"type": "integer",
|
|
1527
|
+
"description": "number of times to retry the populate call before failure",
|
|
1528
|
+
"default": 5
|
|
1529
|
+
},
|
|
1530
|
+
"sort": {
|
|
1531
|
+
"type": "boolean",
|
|
1532
|
+
"description": "whether to sort the data or not",
|
|
1533
|
+
"default": true
|
|
1534
|
+
},
|
|
1535
|
+
"populate": {
|
|
1536
|
+
"type": "array",
|
|
1537
|
+
"description": "Information for the call(s) used to populate the cache",
|
|
1538
|
+
"items": {
|
|
1539
|
+
"type": "object",
|
|
1540
|
+
"properties": {
|
|
1541
|
+
"path": {
|
|
1542
|
+
"type": "string",
|
|
1543
|
+
"description": "The fully qualified path of the call to getDevice (e.g. /rest/api/device/{deviceid})",
|
|
1544
|
+
"default": ""
|
|
1545
|
+
},
|
|
1546
|
+
"method": {
|
|
1547
|
+
"type": "string",
|
|
1548
|
+
"description": "The method of the call to getDevice",
|
|
1549
|
+
"default": "GET"
|
|
1550
|
+
},
|
|
1551
|
+
"pagination": {
|
|
1552
|
+
"type": "object",
|
|
1553
|
+
"description": "todo",
|
|
1554
|
+
"properties": {
|
|
1555
|
+
"offsetVar": {
|
|
1556
|
+
"type": "string",
|
|
1557
|
+
"description": "Name of variable that defines how to go to next set of results"
|
|
1558
|
+
},
|
|
1559
|
+
"limitVar": {
|
|
1560
|
+
"type": "string",
|
|
1561
|
+
"description": "Name of variable that defines the max results returned in a request"
|
|
1562
|
+
},
|
|
1563
|
+
"incrementBy": {
|
|
1564
|
+
"type": "string",
|
|
1565
|
+
"enum": [
|
|
1566
|
+
"limit",
|
|
1567
|
+
"page"
|
|
1568
|
+
],
|
|
1569
|
+
"description": "How to incremenet offset. Default limit",
|
|
1570
|
+
"default": "limit"
|
|
1571
|
+
},
|
|
1572
|
+
"requestLocation": {
|
|
1573
|
+
"type": "string",
|
|
1574
|
+
"enum": [
|
|
1575
|
+
"query",
|
|
1576
|
+
"body"
|
|
1577
|
+
],
|
|
1578
|
+
"description": "Where in request the pagination data goes",
|
|
1579
|
+
"default": "query"
|
|
1580
|
+
}
|
|
1581
|
+
}
|
|
1582
|
+
},
|
|
1583
|
+
"query": {
|
|
1584
|
+
"type": "object",
|
|
1585
|
+
"description": "The json object with query parameters of the call to getDevice",
|
|
1586
|
+
"additionalProperties": {
|
|
1587
|
+
"type": [
|
|
1588
|
+
"string",
|
|
1589
|
+
"number"
|
|
1590
|
+
]
|
|
1591
|
+
}
|
|
1592
|
+
},
|
|
1593
|
+
"body": {
|
|
1594
|
+
"type": "object",
|
|
1595
|
+
"description": "The json object with body of the call to getDevice",
|
|
1596
|
+
"additionalProperties": {
|
|
1597
|
+
"type": [
|
|
1598
|
+
"string",
|
|
1599
|
+
"number"
|
|
1600
|
+
]
|
|
1601
|
+
}
|
|
1602
|
+
},
|
|
1603
|
+
"headers": {
|
|
1604
|
+
"type": "object",
|
|
1605
|
+
"description": "The json object with headers of the call to getDevice",
|
|
1606
|
+
"additionalProperties": {
|
|
1607
|
+
"type": [
|
|
1608
|
+
"string",
|
|
1609
|
+
"number"
|
|
1610
|
+
]
|
|
1611
|
+
}
|
|
1612
|
+
},
|
|
1613
|
+
"handleFailure": {
|
|
1614
|
+
"type": "string",
|
|
1615
|
+
"enum": [
|
|
1616
|
+
"ignore",
|
|
1617
|
+
"fail"
|
|
1618
|
+
],
|
|
1619
|
+
"description": "return failure or ignore failure",
|
|
1620
|
+
"default": "ignore"
|
|
1621
|
+
},
|
|
1622
|
+
"requestFields": {
|
|
1623
|
+
"type": "object",
|
|
1624
|
+
"description": "The json object with response fields of the call to getDevice",
|
|
1625
|
+
"additionalProperties": {
|
|
1626
|
+
"type": [
|
|
1627
|
+
"string",
|
|
1628
|
+
"number"
|
|
1629
|
+
]
|
|
1630
|
+
},
|
|
1631
|
+
"properties": {}
|
|
1632
|
+
},
|
|
1633
|
+
"responseDatakey": {
|
|
1634
|
+
"type": "string",
|
|
1635
|
+
"description": "place in the response where the data is - supports jsonquery",
|
|
1636
|
+
"default": ""
|
|
1637
|
+
},
|
|
1638
|
+
"responseFields": {
|
|
1639
|
+
"type": "object",
|
|
1640
|
+
"description": "The json object with response fields of the call to getDevice",
|
|
1641
|
+
"additionalProperties": {
|
|
1642
|
+
"type": [
|
|
1643
|
+
"string",
|
|
1644
|
+
"number"
|
|
1645
|
+
]
|
|
1646
|
+
}
|
|
1647
|
+
}
|
|
1648
|
+
}
|
|
1649
|
+
}
|
|
1650
|
+
},
|
|
1651
|
+
"cachedTasks": {
|
|
1652
|
+
"type": "array",
|
|
1653
|
+
"description": "Information for the call(s) used to populate the cache",
|
|
1654
|
+
"items": {
|
|
1655
|
+
"type": "object",
|
|
1656
|
+
"properties": {
|
|
1657
|
+
"name": {
|
|
1658
|
+
"type": "string",
|
|
1659
|
+
"description": "the name of the task/action that should utilize cached information",
|
|
1660
|
+
"default": ""
|
|
1661
|
+
},
|
|
1662
|
+
"filterField": {
|
|
1663
|
+
"type": "string",
|
|
1664
|
+
"description": "the field that contains filter information for this call",
|
|
1665
|
+
"default": ""
|
|
1666
|
+
},
|
|
1667
|
+
"filterLoc": {
|
|
1668
|
+
"type": "string",
|
|
1669
|
+
"description": "the field that contains the location of the filter field",
|
|
1670
|
+
"default": ""
|
|
1671
|
+
}
|
|
1672
|
+
}
|
|
1673
|
+
}
|
|
1674
|
+
}
|
|
1675
|
+
}
|
|
1676
|
+
}
|
|
1677
|
+
}
|
|
1678
|
+
}
|
|
1282
1679
|
}
|
|
1283
1680
|
}
|
|
1284
1681
|
}
|