@itentialopensource/adapter-amazon_route53 0.2.2 → 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/AUTH.md +25 -22
- package/CALLS.md +59 -22
- package/CHANGELOG.md +16 -0
- package/CONTRIBUTING.md +1 -160
- package/ENHANCE.md +2 -2
- package/README.md +32 -23
- package/SYSTEMINFO.md +15 -5
- package/adapter.js +600 -1783
- package/adapterBase.js +549 -879
- package/changelogs/changelog.md +54 -0
- package/entities/.system/action.json +2 -2
- package/entities/Rest/action.json +109 -109
- package/metadata.json +70 -0
- package/package.json +24 -28
- package/pronghorn.json +981 -642
- package/propertiesSchema.json +439 -39
- package/refs?service=git-upload-pack +0 -0
- package/report/adapter-openapi.json +15721 -0
- package/report/adapter-openapi.yaml +11633 -0
- package/report/adapterInfo.json +8 -8
- package/report/updateReport1691507399893.json +120 -0
- package/report/updateReport1692202434448.json +120 -0
- package/report/updateReport1694460669097.json +120 -0
- package/report/updateReport1698420502742.json +120 -0
- package/sampleProperties.json +68 -5
- 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
|
@@ -19,14 +19,6 @@
|
|
|
19
19
|
"us-east-1"
|
|
20
20
|
]
|
|
21
21
|
},
|
|
22
|
-
"aws_ver": {
|
|
23
|
-
"type": "string",
|
|
24
|
-
"description": "region of the server",
|
|
25
|
-
"default": "20130401",
|
|
26
|
-
"examples": [
|
|
27
|
-
"20130401"
|
|
28
|
-
]
|
|
29
|
-
},
|
|
30
22
|
"port": {
|
|
31
23
|
"type": "integer",
|
|
32
24
|
"description": "port on which to connect to the server",
|
|
@@ -34,6 +26,11 @@
|
|
|
34
26
|
"minimum": 1,
|
|
35
27
|
"maximum": 65535
|
|
36
28
|
},
|
|
29
|
+
"choosepath": {
|
|
30
|
+
"type": "string",
|
|
31
|
+
"description": "choose the path to use -- requires entityPath choices",
|
|
32
|
+
"default": ""
|
|
33
|
+
},
|
|
37
34
|
"base_path": {
|
|
38
35
|
"type": "string",
|
|
39
36
|
"description": "a base path that is consistent across api calls",
|
|
@@ -94,6 +91,14 @@
|
|
|
94
91
|
"https"
|
|
95
92
|
]
|
|
96
93
|
},
|
|
94
|
+
"service": {
|
|
95
|
+
"type": "string",
|
|
96
|
+
"description": "Service we are integrating with -- used with AWS Authentication",
|
|
97
|
+
"examples": [
|
|
98
|
+
"ec2",
|
|
99
|
+
"route53"
|
|
100
|
+
]
|
|
101
|
+
},
|
|
97
102
|
"authentication": {
|
|
98
103
|
"$ref": "#/definitions/authentication"
|
|
99
104
|
},
|
|
@@ -117,6 +122,9 @@
|
|
|
117
122
|
},
|
|
118
123
|
"devicebroker": {
|
|
119
124
|
"$ref": "#/definitions/devicebroker"
|
|
125
|
+
},
|
|
126
|
+
"cache": {
|
|
127
|
+
"$ref": "#/definitions/cache"
|
|
120
128
|
}
|
|
121
129
|
},
|
|
122
130
|
"required": [
|
|
@@ -138,7 +146,9 @@
|
|
|
138
146
|
"static_token",
|
|
139
147
|
"jwt_token",
|
|
140
148
|
"request_token",
|
|
141
|
-
"no_authentication"
|
|
149
|
+
"no_authentication",
|
|
150
|
+
"multi_step_authentication",
|
|
151
|
+
"aws_authentication"
|
|
142
152
|
]
|
|
143
153
|
},
|
|
144
154
|
"username": {
|
|
@@ -272,6 +282,74 @@
|
|
|
272
282
|
"description": "The grant type for OAuth requests - can also provide in schema",
|
|
273
283
|
"default": ""
|
|
274
284
|
},
|
|
285
|
+
"sensitive": {
|
|
286
|
+
"type": "array",
|
|
287
|
+
"description": "List of sensitive keys to search and hide values from being logged",
|
|
288
|
+
"default": [],
|
|
289
|
+
"items": {
|
|
290
|
+
"type": "string"
|
|
291
|
+
}
|
|
292
|
+
},
|
|
293
|
+
"sso": {
|
|
294
|
+
"type": "object",
|
|
295
|
+
"properties": {
|
|
296
|
+
"protocol": {
|
|
297
|
+
"type": "string",
|
|
298
|
+
"description": "the protocol to request token from system",
|
|
299
|
+
"default": "",
|
|
300
|
+
"enum": [
|
|
301
|
+
"http",
|
|
302
|
+
"https",
|
|
303
|
+
""
|
|
304
|
+
]
|
|
305
|
+
},
|
|
306
|
+
"host": {
|
|
307
|
+
"type": "string",
|
|
308
|
+
"description": "hostname of the authentication system",
|
|
309
|
+
"default": "",
|
|
310
|
+
"examples": [
|
|
311
|
+
"systemx.customer.com"
|
|
312
|
+
]
|
|
313
|
+
},
|
|
314
|
+
"port": {
|
|
315
|
+
"type": "integer",
|
|
316
|
+
"description": "port on which to connect to the authentication system",
|
|
317
|
+
"default": 0,
|
|
318
|
+
"minimum": 0,
|
|
319
|
+
"maximum": 65535
|
|
320
|
+
}
|
|
321
|
+
}
|
|
322
|
+
},
|
|
323
|
+
"multiStepAuthCalls": {
|
|
324
|
+
"type": "array",
|
|
325
|
+
"items": {
|
|
326
|
+
"type": "object",
|
|
327
|
+
"properties": {
|
|
328
|
+
"name": {
|
|
329
|
+
"type": "string",
|
|
330
|
+
"description": "Id of the step call",
|
|
331
|
+
"examples": [
|
|
332
|
+
"getAccessToken"
|
|
333
|
+
]
|
|
334
|
+
},
|
|
335
|
+
"requestFields": {
|
|
336
|
+
"type": "object",
|
|
337
|
+
"description": "The fields set in step request"
|
|
338
|
+
},
|
|
339
|
+
"responseFields": {
|
|
340
|
+
"type": "object",
|
|
341
|
+
"description": "The fields from the step result"
|
|
342
|
+
},
|
|
343
|
+
"successfullResponseCode": {
|
|
344
|
+
"type": "integer",
|
|
345
|
+
"description": "Expected response code for given step, if not set any successfull http response is accepted",
|
|
346
|
+
"examples": [
|
|
347
|
+
200
|
|
348
|
+
]
|
|
349
|
+
}
|
|
350
|
+
}
|
|
351
|
+
}
|
|
352
|
+
},
|
|
275
353
|
"aws_access_key": {
|
|
276
354
|
"type": "string",
|
|
277
355
|
"description": "AWS access key for authentication",
|
|
@@ -295,6 +373,14 @@
|
|
|
295
373
|
"examples": [
|
|
296
374
|
"sessionToken"
|
|
297
375
|
]
|
|
376
|
+
},
|
|
377
|
+
"aws_iam_role": {
|
|
378
|
+
"type": "string",
|
|
379
|
+
"description": "AWS IAM Role for all calls - not all systems require this",
|
|
380
|
+
"default": "",
|
|
381
|
+
"examples": [
|
|
382
|
+
"roleOnAllCalls"
|
|
383
|
+
]
|
|
298
384
|
}
|
|
299
385
|
},
|
|
300
386
|
"required": [
|
|
@@ -397,7 +483,13 @@
|
|
|
397
483
|
},
|
|
398
484
|
"query_object": {
|
|
399
485
|
"type": "object",
|
|
400
|
-
"description": "Query object { device: xxxxx } to be placed into the healthcheck, will be converted to query string by the adapter"
|
|
486
|
+
"description": "Query object { device: xxxxx } to be placed into the healthcheck, will be converted to query string by the adapter",
|
|
487
|
+
"default": {}
|
|
488
|
+
},
|
|
489
|
+
"addlHeaders": {
|
|
490
|
+
"type": "object",
|
|
491
|
+
"description": "headers that will be appended to the headers for the call",
|
|
492
|
+
"default": {}
|
|
401
493
|
}
|
|
402
494
|
},
|
|
403
495
|
"required": [
|
|
@@ -477,6 +569,7 @@
|
|
|
477
569
|
"priorities": {
|
|
478
570
|
"type": "array",
|
|
479
571
|
"description": "define your priorities here",
|
|
572
|
+
"default": [],
|
|
480
573
|
"items": {
|
|
481
574
|
"type": "object",
|
|
482
575
|
"properties": {
|
|
@@ -547,6 +640,7 @@
|
|
|
547
640
|
"failover_codes": {
|
|
548
641
|
"type": "array",
|
|
549
642
|
"description": "An array of codes where it is ok to try another method",
|
|
643
|
+
"default": [],
|
|
550
644
|
"items": {
|
|
551
645
|
"type": "integer"
|
|
552
646
|
}
|
|
@@ -564,19 +658,23 @@
|
|
|
564
658
|
"properties": {
|
|
565
659
|
"payload": {
|
|
566
660
|
"type": "object",
|
|
567
|
-
"description": "payload fields that will be appended to the provided payload (excluding GET calls)"
|
|
661
|
+
"description": "payload fields that will be appended to the provided payload (excluding GET calls)",
|
|
662
|
+
"default": {}
|
|
568
663
|
},
|
|
569
664
|
"uriOptions": {
|
|
570
665
|
"type": "object",
|
|
571
|
-
"description": "options that will be appended to all GET calls"
|
|
666
|
+
"description": "options that will be appended to all GET calls",
|
|
667
|
+
"default": {}
|
|
572
668
|
},
|
|
573
669
|
"addlHeaders": {
|
|
574
670
|
"type": "object",
|
|
575
|
-
"description": "headers that will be appended to the headers for the call"
|
|
671
|
+
"description": "headers that will be appended to the headers for the call",
|
|
672
|
+
"default": {}
|
|
576
673
|
},
|
|
577
674
|
"authData": {
|
|
578
675
|
"type": "object",
|
|
579
|
-
"description": "authentication data that will be appended to the payload for authentication calls"
|
|
676
|
+
"description": "authentication data that will be appended to the payload for authentication calls",
|
|
677
|
+
"default": {}
|
|
580
678
|
}
|
|
581
679
|
}
|
|
582
680
|
},
|
|
@@ -891,6 +989,7 @@
|
|
|
891
989
|
"type": "array",
|
|
892
990
|
"description": "Broker call(s) to getDevice",
|
|
893
991
|
"items": {
|
|
992
|
+
"type": "object",
|
|
894
993
|
"properties": {
|
|
895
994
|
"path": {
|
|
896
995
|
"type": "string",
|
|
@@ -906,21 +1005,30 @@
|
|
|
906
1005
|
"type": "object",
|
|
907
1006
|
"description": "The json object with query parameters of the call to getDevice",
|
|
908
1007
|
"additionalProperties": {
|
|
909
|
-
"type":
|
|
1008
|
+
"type": [
|
|
1009
|
+
"string",
|
|
1010
|
+
"number"
|
|
1011
|
+
]
|
|
910
1012
|
}
|
|
911
1013
|
},
|
|
912
1014
|
"body": {
|
|
913
1015
|
"type": "object",
|
|
914
1016
|
"description": "The json object with body of the call to getDevice",
|
|
915
1017
|
"additionalProperties": {
|
|
916
|
-
"type":
|
|
1018
|
+
"type": [
|
|
1019
|
+
"string",
|
|
1020
|
+
"number"
|
|
1021
|
+
]
|
|
917
1022
|
}
|
|
918
1023
|
},
|
|
919
1024
|
"headers": {
|
|
920
1025
|
"type": "object",
|
|
921
1026
|
"description": "The json object with headers of the call to getDevice",
|
|
922
1027
|
"additionalProperties": {
|
|
923
|
-
"type":
|
|
1028
|
+
"type": [
|
|
1029
|
+
"string",
|
|
1030
|
+
"number"
|
|
1031
|
+
]
|
|
924
1032
|
}
|
|
925
1033
|
},
|
|
926
1034
|
"handleFailure": {
|
|
@@ -936,7 +1044,10 @@
|
|
|
936
1044
|
"type": "object",
|
|
937
1045
|
"description": "The json object with response fields of the call to getDevice",
|
|
938
1046
|
"additionalProperties": {
|
|
939
|
-
"type":
|
|
1047
|
+
"type": [
|
|
1048
|
+
"string",
|
|
1049
|
+
"number"
|
|
1050
|
+
]
|
|
940
1051
|
},
|
|
941
1052
|
"properties": {}
|
|
942
1053
|
},
|
|
@@ -949,7 +1060,10 @@
|
|
|
949
1060
|
"type": "object",
|
|
950
1061
|
"description": "The json object with response fields of the call to getDevice",
|
|
951
1062
|
"additionalProperties": {
|
|
952
|
-
"type":
|
|
1063
|
+
"type": [
|
|
1064
|
+
"string",
|
|
1065
|
+
"number"
|
|
1066
|
+
]
|
|
953
1067
|
},
|
|
954
1068
|
"properties": {
|
|
955
1069
|
"name": {
|
|
@@ -986,6 +1100,7 @@
|
|
|
986
1100
|
"type": "array",
|
|
987
1101
|
"description": "Broker call(s) to getDevicesFiltered",
|
|
988
1102
|
"items": {
|
|
1103
|
+
"type": "object",
|
|
989
1104
|
"properties": {
|
|
990
1105
|
"path": {
|
|
991
1106
|
"type": "string",
|
|
@@ -997,25 +1112,66 @@
|
|
|
997
1112
|
"description": "The method of the call to getDevicesFiltered",
|
|
998
1113
|
"default": "GET"
|
|
999
1114
|
},
|
|
1115
|
+
"pagination": {
|
|
1116
|
+
"type": "object",
|
|
1117
|
+
"description": "todo",
|
|
1118
|
+
"properties": {
|
|
1119
|
+
"offsetVar": {
|
|
1120
|
+
"type": "string",
|
|
1121
|
+
"description": "Name of variable that defines how to go to next set of results"
|
|
1122
|
+
},
|
|
1123
|
+
"limitVar": {
|
|
1124
|
+
"type": "string",
|
|
1125
|
+
"description": "Name of variable that defines the max results returned in a request"
|
|
1126
|
+
},
|
|
1127
|
+
"incrementBy": {
|
|
1128
|
+
"type": "string",
|
|
1129
|
+
"enum": [
|
|
1130
|
+
"limit",
|
|
1131
|
+
"page"
|
|
1132
|
+
],
|
|
1133
|
+
"description": "How to incremenet offset. Default limit",
|
|
1134
|
+
"default": "limit"
|
|
1135
|
+
},
|
|
1136
|
+
"requestLocation": {
|
|
1137
|
+
"type": "string",
|
|
1138
|
+
"enum": [
|
|
1139
|
+
"query",
|
|
1140
|
+
"body"
|
|
1141
|
+
],
|
|
1142
|
+
"description": "Where in request the pagination data goes",
|
|
1143
|
+
"default": "query"
|
|
1144
|
+
}
|
|
1145
|
+
}
|
|
1146
|
+
},
|
|
1000
1147
|
"query": {
|
|
1001
1148
|
"type": "object",
|
|
1002
1149
|
"description": "The json object with query parameters of the call to getDevicesFiltered",
|
|
1003
1150
|
"additionalProperties": {
|
|
1004
|
-
"type":
|
|
1151
|
+
"type": [
|
|
1152
|
+
"string",
|
|
1153
|
+
"number"
|
|
1154
|
+
]
|
|
1005
1155
|
}
|
|
1006
1156
|
},
|
|
1007
1157
|
"body": {
|
|
1008
1158
|
"type": "object",
|
|
1009
1159
|
"description": "The json object with body of the call to getDevicesFiltered",
|
|
1010
1160
|
"additionalProperties": {
|
|
1011
|
-
"type":
|
|
1161
|
+
"type": [
|
|
1162
|
+
"string",
|
|
1163
|
+
"number"
|
|
1164
|
+
]
|
|
1012
1165
|
}
|
|
1013
1166
|
},
|
|
1014
1167
|
"headers": {
|
|
1015
1168
|
"type": "object",
|
|
1016
1169
|
"description": "The json object with headers of the call to getDevicesFiltered",
|
|
1017
1170
|
"additionalProperties": {
|
|
1018
|
-
"type":
|
|
1171
|
+
"type": [
|
|
1172
|
+
"string",
|
|
1173
|
+
"number"
|
|
1174
|
+
]
|
|
1019
1175
|
}
|
|
1020
1176
|
},
|
|
1021
1177
|
"handleFailure": {
|
|
@@ -1031,7 +1187,10 @@
|
|
|
1031
1187
|
"type": "object",
|
|
1032
1188
|
"description": "The json object with response fields of the call to getDevice",
|
|
1033
1189
|
"additionalProperties": {
|
|
1034
|
-
"type":
|
|
1190
|
+
"type": [
|
|
1191
|
+
"string",
|
|
1192
|
+
"number"
|
|
1193
|
+
]
|
|
1035
1194
|
},
|
|
1036
1195
|
"properties": {}
|
|
1037
1196
|
},
|
|
@@ -1044,7 +1203,10 @@
|
|
|
1044
1203
|
"type": "object",
|
|
1045
1204
|
"description": "The json object with response fields of the call to getDevicesFiltered",
|
|
1046
1205
|
"additionalProperties": {
|
|
1047
|
-
"type":
|
|
1206
|
+
"type": [
|
|
1207
|
+
"string",
|
|
1208
|
+
"number"
|
|
1209
|
+
]
|
|
1048
1210
|
},
|
|
1049
1211
|
"properties": {
|
|
1050
1212
|
"name": {
|
|
@@ -1081,6 +1243,7 @@
|
|
|
1081
1243
|
"type": "array",
|
|
1082
1244
|
"description": "Broker call(s) to determine if the device isAlive",
|
|
1083
1245
|
"items": {
|
|
1246
|
+
"type": "object",
|
|
1084
1247
|
"properties": {
|
|
1085
1248
|
"path": {
|
|
1086
1249
|
"type": "string",
|
|
@@ -1096,21 +1259,30 @@
|
|
|
1096
1259
|
"type": "object",
|
|
1097
1260
|
"description": "The json object with query parameters of the call to isAlive",
|
|
1098
1261
|
"additionalProperties": {
|
|
1099
|
-
"type":
|
|
1262
|
+
"type": [
|
|
1263
|
+
"string",
|
|
1264
|
+
"number"
|
|
1265
|
+
]
|
|
1100
1266
|
}
|
|
1101
1267
|
},
|
|
1102
1268
|
"body": {
|
|
1103
1269
|
"type": "object",
|
|
1104
1270
|
"description": "The json object with body of the call to isAlive",
|
|
1105
1271
|
"additionalProperties": {
|
|
1106
|
-
"type":
|
|
1272
|
+
"type": [
|
|
1273
|
+
"string",
|
|
1274
|
+
"number"
|
|
1275
|
+
]
|
|
1107
1276
|
}
|
|
1108
1277
|
},
|
|
1109
1278
|
"headers": {
|
|
1110
1279
|
"type": "object",
|
|
1111
1280
|
"description": "The json object with headers of the call to isAlive",
|
|
1112
1281
|
"additionalProperties": {
|
|
1113
|
-
"type":
|
|
1282
|
+
"type": [
|
|
1283
|
+
"string",
|
|
1284
|
+
"number"
|
|
1285
|
+
]
|
|
1114
1286
|
}
|
|
1115
1287
|
},
|
|
1116
1288
|
"handleFailure": {
|
|
@@ -1126,7 +1298,10 @@
|
|
|
1126
1298
|
"type": "object",
|
|
1127
1299
|
"description": "The json object with response fields of the call to getDevice",
|
|
1128
1300
|
"additionalProperties": {
|
|
1129
|
-
"type":
|
|
1301
|
+
"type": [
|
|
1302
|
+
"string",
|
|
1303
|
+
"number"
|
|
1304
|
+
]
|
|
1130
1305
|
},
|
|
1131
1306
|
"properties": {}
|
|
1132
1307
|
},
|
|
@@ -1139,7 +1314,10 @@
|
|
|
1139
1314
|
"type": "object",
|
|
1140
1315
|
"description": "The json object with response fields of the call to isAlive",
|
|
1141
1316
|
"additionalProperties": {
|
|
1142
|
-
"type":
|
|
1317
|
+
"type": [
|
|
1318
|
+
"string",
|
|
1319
|
+
"number"
|
|
1320
|
+
]
|
|
1143
1321
|
},
|
|
1144
1322
|
"properties": {
|
|
1145
1323
|
"status": {
|
|
@@ -1161,6 +1339,7 @@
|
|
|
1161
1339
|
"type": "array",
|
|
1162
1340
|
"description": "Broker call(s) to getConfig",
|
|
1163
1341
|
"items": {
|
|
1342
|
+
"type": "object",
|
|
1164
1343
|
"properties": {
|
|
1165
1344
|
"path": {
|
|
1166
1345
|
"type": "string",
|
|
@@ -1176,21 +1355,30 @@
|
|
|
1176
1355
|
"type": "object",
|
|
1177
1356
|
"description": "The json object with query parameters of the call to getConfig",
|
|
1178
1357
|
"additionalProperties": {
|
|
1179
|
-
"type":
|
|
1358
|
+
"type": [
|
|
1359
|
+
"string",
|
|
1360
|
+
"number"
|
|
1361
|
+
]
|
|
1180
1362
|
}
|
|
1181
1363
|
},
|
|
1182
1364
|
"body": {
|
|
1183
1365
|
"type": "object",
|
|
1184
1366
|
"description": "The json object with body of the call to getConfig",
|
|
1185
1367
|
"additionalProperties": {
|
|
1186
|
-
"type":
|
|
1368
|
+
"type": [
|
|
1369
|
+
"string",
|
|
1370
|
+
"number"
|
|
1371
|
+
]
|
|
1187
1372
|
}
|
|
1188
1373
|
},
|
|
1189
1374
|
"headers": {
|
|
1190
1375
|
"type": "object",
|
|
1191
1376
|
"description": "The json object with headers of the call to getConfig",
|
|
1192
1377
|
"additionalProperties": {
|
|
1193
|
-
"type":
|
|
1378
|
+
"type": [
|
|
1379
|
+
"string",
|
|
1380
|
+
"number"
|
|
1381
|
+
]
|
|
1194
1382
|
}
|
|
1195
1383
|
},
|
|
1196
1384
|
"handleFailure": {
|
|
@@ -1206,7 +1394,10 @@
|
|
|
1206
1394
|
"type": "object",
|
|
1207
1395
|
"description": "The json object with response fields of the call to getDevice",
|
|
1208
1396
|
"additionalProperties": {
|
|
1209
|
-
"type":
|
|
1397
|
+
"type": [
|
|
1398
|
+
"string",
|
|
1399
|
+
"number"
|
|
1400
|
+
]
|
|
1210
1401
|
},
|
|
1211
1402
|
"properties": {}
|
|
1212
1403
|
},
|
|
@@ -1219,7 +1410,10 @@
|
|
|
1219
1410
|
"type": "object",
|
|
1220
1411
|
"description": "The json object with response fields of the call to getConfig",
|
|
1221
1412
|
"additionalProperties": {
|
|
1222
|
-
"type":
|
|
1413
|
+
"type": [
|
|
1414
|
+
"string",
|
|
1415
|
+
"number"
|
|
1416
|
+
]
|
|
1223
1417
|
},
|
|
1224
1418
|
"properties": {}
|
|
1225
1419
|
}
|
|
@@ -1230,6 +1424,7 @@
|
|
|
1230
1424
|
"type": "array",
|
|
1231
1425
|
"description": "Broker call(s) to getCount",
|
|
1232
1426
|
"items": {
|
|
1427
|
+
"type": "object",
|
|
1233
1428
|
"properties": {
|
|
1234
1429
|
"path": {
|
|
1235
1430
|
"type": "string",
|
|
@@ -1245,21 +1440,30 @@
|
|
|
1245
1440
|
"type": "object",
|
|
1246
1441
|
"description": "The json object with query parameters of the call to getCount",
|
|
1247
1442
|
"additionalProperties": {
|
|
1248
|
-
"type":
|
|
1443
|
+
"type": [
|
|
1444
|
+
"string",
|
|
1445
|
+
"number"
|
|
1446
|
+
]
|
|
1249
1447
|
}
|
|
1250
1448
|
},
|
|
1251
1449
|
"body": {
|
|
1252
1450
|
"type": "object",
|
|
1253
1451
|
"description": "The json object with body of the call to getCount",
|
|
1254
1452
|
"additionalProperties": {
|
|
1255
|
-
"type":
|
|
1453
|
+
"type": [
|
|
1454
|
+
"string",
|
|
1455
|
+
"number"
|
|
1456
|
+
]
|
|
1256
1457
|
}
|
|
1257
1458
|
},
|
|
1258
1459
|
"headers": {
|
|
1259
1460
|
"type": "object",
|
|
1260
1461
|
"description": "The json object with headers of the call to getCount",
|
|
1261
1462
|
"additionalProperties": {
|
|
1262
|
-
"type":
|
|
1463
|
+
"type": [
|
|
1464
|
+
"string",
|
|
1465
|
+
"number"
|
|
1466
|
+
]
|
|
1263
1467
|
}
|
|
1264
1468
|
},
|
|
1265
1469
|
"handleFailure": {
|
|
@@ -1275,7 +1479,10 @@
|
|
|
1275
1479
|
"type": "object",
|
|
1276
1480
|
"description": "The json object with response fields of the call to getDevice",
|
|
1277
1481
|
"additionalProperties": {
|
|
1278
|
-
"type":
|
|
1482
|
+
"type": [
|
|
1483
|
+
"string",
|
|
1484
|
+
"number"
|
|
1485
|
+
]
|
|
1279
1486
|
},
|
|
1280
1487
|
"properties": {}
|
|
1281
1488
|
},
|
|
@@ -1288,7 +1495,10 @@
|
|
|
1288
1495
|
"type": "object",
|
|
1289
1496
|
"description": "The json object with response fields of the call to getConfig",
|
|
1290
1497
|
"additionalProperties": {
|
|
1291
|
-
"type":
|
|
1498
|
+
"type": [
|
|
1499
|
+
"string",
|
|
1500
|
+
"number"
|
|
1501
|
+
]
|
|
1292
1502
|
},
|
|
1293
1503
|
"properties": {}
|
|
1294
1504
|
}
|
|
@@ -1296,6 +1506,196 @@
|
|
|
1296
1506
|
}
|
|
1297
1507
|
}
|
|
1298
1508
|
}
|
|
1509
|
+
},
|
|
1510
|
+
"cache": {
|
|
1511
|
+
"type": "object",
|
|
1512
|
+
"properties": {
|
|
1513
|
+
"enabled": {
|
|
1514
|
+
"type": "boolean",
|
|
1515
|
+
"description": "Whether or not cache is enabled for adapter",
|
|
1516
|
+
"default": false
|
|
1517
|
+
},
|
|
1518
|
+
"entities": {
|
|
1519
|
+
"type": "array",
|
|
1520
|
+
"description": "Information for the cached entities",
|
|
1521
|
+
"items": {
|
|
1522
|
+
"type": "object",
|
|
1523
|
+
"properties": {
|
|
1524
|
+
"entityType": {
|
|
1525
|
+
"type": "string",
|
|
1526
|
+
"description": "The name of the entity - should match adapter entity configuration or a broker (e.g. Device)",
|
|
1527
|
+
"default": ""
|
|
1528
|
+
},
|
|
1529
|
+
"frequency": {
|
|
1530
|
+
"type": "integer",
|
|
1531
|
+
"description": "how long (in minutes) we wait to re-populate the cache",
|
|
1532
|
+
"default": 1440,
|
|
1533
|
+
"maximum": 10080
|
|
1534
|
+
},
|
|
1535
|
+
"flushOnFail": {
|
|
1536
|
+
"type": "boolean",
|
|
1537
|
+
"description": "Whether to clear the cache we have if the populate failed",
|
|
1538
|
+
"default": false
|
|
1539
|
+
},
|
|
1540
|
+
"limit": {
|
|
1541
|
+
"type": "integer",
|
|
1542
|
+
"description": "maximum number of items to keep in cache",
|
|
1543
|
+
"default": 1000
|
|
1544
|
+
},
|
|
1545
|
+
"retryAttempts": {
|
|
1546
|
+
"type": "integer",
|
|
1547
|
+
"description": "number of times to retry the populate call before failure",
|
|
1548
|
+
"default": 5
|
|
1549
|
+
},
|
|
1550
|
+
"sort": {
|
|
1551
|
+
"type": "boolean",
|
|
1552
|
+
"description": "whether to sort the data or not",
|
|
1553
|
+
"default": true
|
|
1554
|
+
},
|
|
1555
|
+
"populate": {
|
|
1556
|
+
"type": "array",
|
|
1557
|
+
"description": "Information for the call(s) used to populate the cache",
|
|
1558
|
+
"items": {
|
|
1559
|
+
"type": "object",
|
|
1560
|
+
"properties": {
|
|
1561
|
+
"path": {
|
|
1562
|
+
"type": "string",
|
|
1563
|
+
"description": "The fully qualified path of the call to getDevice (e.g. /rest/api/device/{deviceid})",
|
|
1564
|
+
"default": ""
|
|
1565
|
+
},
|
|
1566
|
+
"method": {
|
|
1567
|
+
"type": "string",
|
|
1568
|
+
"description": "The method of the call to getDevice",
|
|
1569
|
+
"default": "GET"
|
|
1570
|
+
},
|
|
1571
|
+
"pagination": {
|
|
1572
|
+
"type": "object",
|
|
1573
|
+
"description": "todo",
|
|
1574
|
+
"properties": {
|
|
1575
|
+
"offsetVar": {
|
|
1576
|
+
"type": "string",
|
|
1577
|
+
"description": "Name of variable that defines how to go to next set of results"
|
|
1578
|
+
},
|
|
1579
|
+
"limitVar": {
|
|
1580
|
+
"type": "string",
|
|
1581
|
+
"description": "Name of variable that defines the max results returned in a request"
|
|
1582
|
+
},
|
|
1583
|
+
"incrementBy": {
|
|
1584
|
+
"type": "string",
|
|
1585
|
+
"enum": [
|
|
1586
|
+
"limit",
|
|
1587
|
+
"page"
|
|
1588
|
+
],
|
|
1589
|
+
"description": "How to incremenet offset. Default limit",
|
|
1590
|
+
"default": "limit"
|
|
1591
|
+
},
|
|
1592
|
+
"requestLocation": {
|
|
1593
|
+
"type": "string",
|
|
1594
|
+
"enum": [
|
|
1595
|
+
"query",
|
|
1596
|
+
"body"
|
|
1597
|
+
],
|
|
1598
|
+
"description": "Where in request the pagination data goes",
|
|
1599
|
+
"default": "query"
|
|
1600
|
+
}
|
|
1601
|
+
}
|
|
1602
|
+
},
|
|
1603
|
+
"query": {
|
|
1604
|
+
"type": "object",
|
|
1605
|
+
"description": "The json object with query parameters of the call to getDevice",
|
|
1606
|
+
"additionalProperties": {
|
|
1607
|
+
"type": [
|
|
1608
|
+
"string",
|
|
1609
|
+
"number"
|
|
1610
|
+
]
|
|
1611
|
+
}
|
|
1612
|
+
},
|
|
1613
|
+
"body": {
|
|
1614
|
+
"type": "object",
|
|
1615
|
+
"description": "The json object with body of the call to getDevice",
|
|
1616
|
+
"additionalProperties": {
|
|
1617
|
+
"type": [
|
|
1618
|
+
"string",
|
|
1619
|
+
"number"
|
|
1620
|
+
]
|
|
1621
|
+
}
|
|
1622
|
+
},
|
|
1623
|
+
"headers": {
|
|
1624
|
+
"type": "object",
|
|
1625
|
+
"description": "The json object with headers of the call to getDevice",
|
|
1626
|
+
"additionalProperties": {
|
|
1627
|
+
"type": [
|
|
1628
|
+
"string",
|
|
1629
|
+
"number"
|
|
1630
|
+
]
|
|
1631
|
+
}
|
|
1632
|
+
},
|
|
1633
|
+
"handleFailure": {
|
|
1634
|
+
"type": "string",
|
|
1635
|
+
"enum": [
|
|
1636
|
+
"ignore",
|
|
1637
|
+
"fail"
|
|
1638
|
+
],
|
|
1639
|
+
"description": "return failure or ignore failure",
|
|
1640
|
+
"default": "ignore"
|
|
1641
|
+
},
|
|
1642
|
+
"requestFields": {
|
|
1643
|
+
"type": "object",
|
|
1644
|
+
"description": "The json object with response fields of the call to getDevice",
|
|
1645
|
+
"additionalProperties": {
|
|
1646
|
+
"type": [
|
|
1647
|
+
"string",
|
|
1648
|
+
"number"
|
|
1649
|
+
]
|
|
1650
|
+
},
|
|
1651
|
+
"properties": {}
|
|
1652
|
+
},
|
|
1653
|
+
"responseDatakey": {
|
|
1654
|
+
"type": "string",
|
|
1655
|
+
"description": "place in the response where the data is - supports jsonquery",
|
|
1656
|
+
"default": ""
|
|
1657
|
+
},
|
|
1658
|
+
"responseFields": {
|
|
1659
|
+
"type": "object",
|
|
1660
|
+
"description": "The json object with response fields of the call to getDevice",
|
|
1661
|
+
"additionalProperties": {
|
|
1662
|
+
"type": [
|
|
1663
|
+
"string",
|
|
1664
|
+
"number"
|
|
1665
|
+
]
|
|
1666
|
+
}
|
|
1667
|
+
}
|
|
1668
|
+
}
|
|
1669
|
+
}
|
|
1670
|
+
},
|
|
1671
|
+
"cachedTasks": {
|
|
1672
|
+
"type": "array",
|
|
1673
|
+
"description": "Information for the call(s) used to populate the cache",
|
|
1674
|
+
"items": {
|
|
1675
|
+
"type": "object",
|
|
1676
|
+
"properties": {
|
|
1677
|
+
"name": {
|
|
1678
|
+
"type": "string",
|
|
1679
|
+
"description": "the name of the task/action that should utilize cached information",
|
|
1680
|
+
"default": ""
|
|
1681
|
+
},
|
|
1682
|
+
"filterField": {
|
|
1683
|
+
"type": "string",
|
|
1684
|
+
"description": "the field that contains filter information for this call",
|
|
1685
|
+
"default": ""
|
|
1686
|
+
},
|
|
1687
|
+
"filterLoc": {
|
|
1688
|
+
"type": "string",
|
|
1689
|
+
"description": "the field that contains the location of the filter field",
|
|
1690
|
+
"default": ""
|
|
1691
|
+
}
|
|
1692
|
+
}
|
|
1693
|
+
}
|
|
1694
|
+
}
|
|
1695
|
+
}
|
|
1696
|
+
}
|
|
1697
|
+
}
|
|
1698
|
+
}
|
|
1299
1699
|
}
|
|
1300
1700
|
}
|
|
1301
1701
|
}
|