@itentialopensource/adapter-meraki 0.8.1 → 0.8.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/AUTH.md +14 -15
  2. package/BROKER.md +199 -0
  3. package/CALLS.md +158 -89
  4. package/CHANGELOG.md +68 -26
  5. package/CODE_OF_CONDUCT.md +12 -17
  6. package/CONTRIBUTING.md +88 -74
  7. package/ENHANCE.md +14 -14
  8. package/PROPERTIES.md +483 -89
  9. package/README.md +131 -51
  10. package/SUMMARY.md +2 -2
  11. package/TROUBLESHOOT.md +4 -3
  12. package/adapter.js +174 -732
  13. package/adapterBase.js +841 -88
  14. package/entities/.generic/action.json +105 -0
  15. package/entities/.generic/schema.json +6 -1
  16. package/package.json +5 -3
  17. package/pronghorn.json +642 -563
  18. package/propertiesDecorators.json +14 -0
  19. package/propertiesSchema.json +393 -195
  20. package/refs?service=git-upload-pack +0 -0
  21. package/report/adapterInfo.json +10 -0
  22. package/report/updateReport1651511176919.json +115 -0
  23. package/report/updateReport1652488414759.json +120 -0
  24. package/sampleProperties.json +132 -3
  25. package/test/integration/adapterTestBasicGet.js +1 -1
  26. package/test/integration/adapterTestIntegration.js +24 -107
  27. package/test/unit/adapterBaseTestUnit.js +10 -3
  28. package/test/unit/adapterTestUnit.js +38 -131
  29. package/utils/adapterInfo.js +206 -0
  30. package/utils/entitiesToDB.js +12 -57
  31. package/utils/pre-commit.sh +3 -0
  32. package/utils/tbScript.js +35 -20
  33. package/utils/tbUtils.js +49 -31
  34. package/utils/testRunner.js +16 -16
package/propertiesDecorators.json ADDED
@@ -0,0 +1,14 @@
1
+ [
2
+ {
3
+ "type": "encryption",
4
+ "pointer": "/authentication/password"
5
+ },
6
+ {
7
+ "type": "encryption",
8
+ "pointer": "/authentication/token"
9
+ },
10
+ {
11
+ "type": "encryption",
12
+ "pointer": "/mongo/password"
13
+ }
14
+ ]
package/propertiesSchema.json CHANGED
@@ -51,6 +51,11 @@
51
51
  "description": "When true the path variables are encoded in the url",
52
52
  "default": true
53
53
  },
54
+ "encode_queryvars": {
55
+ "type": "boolean",
56
+ "description": "When true the query parameters are encoded in the url",
57
+ "default": true
58
+ },
54
59
  "save_metric": {
55
60
  "type": [
56
61
  "boolean",
@@ -843,217 +848,410 @@
843
848
  "type": "object",
844
849
  "properties": {
845
850
  "getDevice": {
846
- "type": "object",
847
- "description": "Broker call to getDevice",
848
- "properties": {
849
- "path": {
850
- "type": "string",
851
- "description": "The fully qualified path of the call to getDevice (e.g. /rest/api/device/{deviceid})",
852
- "default": ""
853
- },
854
- "method": {
855
- "type": "string",
856
- "description": "The method of the call to getDevice",
857
- "default": "GET"
858
- },
859
- "query": {
860
- "type": "string",
861
- "description": "The stringified json object with query parameters of the call to getDevice",
862
- "default": "{}"
863
- },
864
- "body": {
865
- "type": "string",
866
- "description": "The stringified json object with body of the call to getDevice",
867
- "default": "{}"
868
- },
869
- "headers": {
870
- "type": "string",
871
- "description": "The stringified json object with headers of the call to getDevice",
872
- "default": "{}"
873
- },
874
- "name_field": {
875
- "type": "string",
876
- "description": "The field in response to getDevice that contains the name of the device",
877
- "default": "name"
878
- },
879
- "ostype_field": {
880
- "type": "string",
881
- "description": "The field in response to getDevice that contains the ostype of the device",
882
- "default": "ostype"
883
- },
884
- "ostypePrefix": {
885
- "type": "string",
886
- "description": "Any prefix that should be added to the ostype of the device (e.g. aws-)",
887
- "default": ""
888
- },
889
- "port_field": {
890
- "type": "string",
891
- "description": "The field in response to getDevice that contains the port of the device",
892
- "default": "port"
893
- },
894
- "ip_field": {
895
- "type": "string",
896
- "description": "The field in response to getDevice that contains the ip address of the device",
897
- "default": "ipaddress"
851
+ "type": "array",
852
+ "description": "Broker call(s) to getDevice",
853
+ "items": {
854
+ "properties": {
855
+ "path": {
856
+ "type": "string",
857
+ "description": "The fully qualified path of the call to getDevice (e.g. /rest/api/device/{deviceid})",
858
+ "default": ""
859
+ },
860
+ "method": {
861
+ "type": "string",
862
+ "description": "The method of the call to getDevice",
863
+ "default": "GET"
864
+ },
865
+ "query": {
866
+ "type": "object",
867
+ "description": "The json object with query parameters of the call to getDevice",
868
+ "additionalProperties": {
869
+ "type": "string"
870
+ }
871
+ },
872
+ "body": {
873
+ "type": "object",
874
+ "description": "The json object with body of the call to getDevice",
875
+ "additionalProperties": {
876
+ "type": "string"
877
+ }
878
+ },
879
+ "headers": {
880
+ "type": "object",
881
+ "description": "The json object with headers of the call to getDevice",
882
+ "additionalProperties": {
883
+ "type": "string"
884
+ }
885
+ },
886
+ "handleFailure": {
887
+ "type": "string",
888
+ "enum": [
889
+ "ignore",
890
+ "fail"
891
+ ],
892
+ "description": "return failure or ignore failure",
893
+ "default": "ignore"
894
+ },
895
+ "requestFields": {
896
+ "type": "object",
897
+ "description": "The json object with response fields of the call to getDevice",
898
+ "additionalProperties": {
899
+ "type": "string"
900
+ },
901
+ "properties": {}
902
+ },
903
+ "responseDatakey": {
904
+ "type": "string",
905
+ "description": "place in the response where the data is - supports jsonquery",
906
+ "default": ""
907
+ },
908
+ "responseFields": {
909
+ "type": "object",
910
+ "description": "The json object with response fields of the call to getDevice",
911
+ "additionalProperties": {
912
+ "type": "string"
913
+ },
914
+ "properties": {
915
+ "name": {
916
+ "type": "string",
917
+ "description": "The field in response to getDevice that contains the name of the device",
918
+ "default": "name"
919
+ },
920
+ "ostype": {
921
+ "type": "string",
922
+ "description": "The field in response to getDevice that contains the ostype of the device",
923
+ "default": "ostype"
924
+ },
925
+ "ostypePrefix": {
926
+ "type": "string",
927
+ "description": "Any prefix that should be added to the ostype of the device (e.g. aws-)",
928
+ "default": ""
929
+ },
930
+ "port": {
931
+ "type": "string",
932
+ "description": "The field in response to getDevice that contains the port of the device",
933
+ "default": ""
934
+ },
935
+ "ipaddress": {
936
+ "type": "string",
937
+ "description": "The field in response to getDevice that contains the ip address of the device",
938
+ "default": ""
939
+ }
940
+ }
941
+ }
898
942
  }
899
943
  }
900
944
  },
901
945
  "getDevicesFiltered": {
902
- "type": "object",
903
- "description": "Broker call to getDevicesFiltered",
904
- "properties": {
905
- "path": {
906
- "type": "string",
907
- "description": "The fully qualified path of the call to getDevicesFiltered (e.g. /rest/api/devices)",
908
- "default": ""
909
- },
910
- "method": {
911
- "type": "string",
912
- "description": "The method of the call to getDevicesFiltered",
913
- "default": "GET"
914
- },
915
- "query": {
916
- "type": "string",
917
- "description": "The stringified json object with query parameters of the call to getDevicesFiltered",
918
- "default": "{}"
919
- },
920
- "body": {
921
- "type": "string",
922
- "description": "The stringified json object with body of the call to getDevicesFiltered",
923
- "default": "{}"
924
- },
925
- "headers": {
926
- "type": "string",
927
- "description": "The stringified json object with headers of the call to getDevicesFiltered",
928
- "default": "{}"
929
- },
930
- "name_field": {
931
- "type": "string",
932
- "description": "The field in response to getDevicesFiltered that contains the name of the device",
933
- "default": "name"
934
- },
935
- "ostype_field": {
936
- "type": "string",
937
- "description": "The field in response to getDevicesFiltered that contains the ostype of the device",
938
- "default": "ostype"
939
- },
940
- "ostypePrefix": {
941
- "type": "string",
942
- "description": "Any prefix that should be added to the ostype of the device (e.g. aws-)",
943
- "default": ""
944
- },
945
- "port_field": {
946
- "type": "string",
947
- "description": "The field in response to getDevicesFiltered that contains the port of the device",
948
- "default": "port"
949
- },
950
- "ip_field": {
951
- "type": "string",
952
- "description": "The field in response to getDevicesFiltered that contains the ip address of the device",
953
- "default": "ipaddress"
946
+ "type": "array",
947
+ "description": "Broker call(s) to getDevicesFiltered",
948
+ "items": {
949
+ "properties": {
950
+ "path": {
951
+ "type": "string",
952
+ "description": "The fully qualified path of the call to getDevicesFiltered (e.g. /rest/api/device/{deviceid})",
953
+ "default": ""
954
+ },
955
+ "method": {
956
+ "type": "string",
957
+ "description": "The method of the call to getDevicesFiltered",
958
+ "default": "GET"
959
+ },
960
+ "query": {
961
+ "type": "object",
962
+ "description": "The json object with query parameters of the call to getDevicesFiltered",
963
+ "additionalProperties": {
964
+ "type": "string"
965
+ }
966
+ },
967
+ "body": {
968
+ "type": "object",
969
+ "description": "The json object with body of the call to getDevicesFiltered",
970
+ "additionalProperties": {
971
+ "type": "string"
972
+ }
973
+ },
974
+ "headers": {
975
+ "type": "object",
976
+ "description": "The json object with headers of the call to getDevicesFiltered",
977
+ "additionalProperties": {
978
+ "type": "string"
979
+ }
980
+ },
981
+ "handleFailure": {
982
+ "type": "string",
983
+ "enum": [
984
+ "ignore",
985
+ "fail"
986
+ ],
987
+ "description": "return failure or ignore failure",
988
+ "default": "ignore"
989
+ },
990
+ "requestFields": {
991
+ "type": "object",
992
+ "description": "The json object with response fields of the call to getDevice",
993
+ "additionalProperties": {
994
+ "type": "string"
995
+ },
996
+ "properties": {}
997
+ },
998
+ "responseDatakey": {
999
+ "type": "string",
1000
+ "description": "place in the response where the data is - supports jsonquery",
1001
+ "default": ""
1002
+ },
1003
+ "responseFields": {
1004
+ "type": "object",
1005
+ "description": "The json object with response fields of the call to getDevicesFiltered",
1006
+ "additionalProperties": {
1007
+ "type": "string"
1008
+ },
1009
+ "properties": {
1010
+ "name": {
1011
+ "type": "string",
1012
+ "description": "The field in response to getDevicesFiltered that contains the name of the device",
1013
+ "default": "name"
1014
+ },
1015
+ "ostype": {
1016
+ "type": "string",
1017
+ "description": "The field in response to getDevicesFiltered that contains the ostype of the device",
1018
+ "default": "ostype"
1019
+ },
1020
+ "ostypePrefix": {
1021
+ "type": "string",
1022
+ "description": "Any prefix that should be added to the ostype of the device (e.g. aws-)",
1023
+ "default": ""
1024
+ },
1025
+ "port": {
1026
+ "type": "string",
1027
+ "description": "The field in response to getDevicesFiltered that contains the port of the device",
1028
+ "default": ""
1029
+ },
1030
+ "ipaddress": {
1031
+ "type": "string",
1032
+ "description": "The field in response to getDevicesFiltered that contains the ip address of the device",
1033
+ "default": ""
1034
+ }
1035
+ }
1036
+ }
954
1037
  }
955
1038
  }
956
1039
  },
957
1040
  "isAlive": {
958
- "type": "object",
959
- "description": "Broker call to isAlive",
960
- "properties": {
961
- "path": {
962
- "type": "string",
963
- "description": "The fully qualified path of the call to isAlive (e.g. /rest/api/device/{deviceid})",
964
- "default": ""
965
- },
966
- "method": {
967
- "type": "string",
968
- "description": "The method of the call to isAlive",
969
- "default": "GET"
970
- },
971
- "query": {
972
- "type": "string",
973
- "description": "The stringified json object with query parameters of the call to isAlive",
974
- "default": "{}"
975
- },
976
- "body": {
977
- "type": "string",
978
- "description": "The stringified json object with body of the call to isAlive",
979
- "default": "{}"
980
- },
981
- "headers": {
982
- "type": "string",
983
- "description": "The stringified json object with headers of the call to isAlive",
984
- "default": "{}"
985
- },
986
- "status_field": {
987
- "type": "string",
988
- "description": "The field in response to isAlive that contains the status of the device",
989
- "default": "status"
990
- },
991
- "status_value": {
992
- "type": "string",
993
- "description": "The status of the device that says it is alive",
994
- "default": "true"
1041
+ "type": "array",
1042
+ "description": "Broker call(s) to determine if the device isAlive",
1043
+ "items": {
1044
+ "properties": {
1045
+ "path": {
1046
+ "type": "string",
1047
+ "description": "The fully qualified path of the call to isAlive (e.g. /rest/api/device/{deviceid})",
1048
+ "default": ""
1049
+ },
1050
+ "method": {
1051
+ "type": "string",
1052
+ "description": "The method of the call to isAlive",
1053
+ "default": "GET"
1054
+ },
1055
+ "query": {
1056
+ "type": "object",
1057
+ "description": "The json object with query parameters of the call to isAlive",
1058
+ "additionalProperties": {
1059
+ "type": "string"
1060
+ }
1061
+ },
1062
+ "body": {
1063
+ "type": "object",
1064
+ "description": "The json object with body of the call to isAlive",
1065
+ "additionalProperties": {
1066
+ "type": "string"
1067
+ }
1068
+ },
1069
+ "headers": {
1070
+ "type": "object",
1071
+ "description": "The json object with headers of the call to isAlive",
1072
+ "additionalProperties": {
1073
+ "type": "string"
1074
+ }
1075
+ },
1076
+ "handleFailure": {
1077
+ "type": "string",
1078
+ "enum": [
1079
+ "ignore",
1080
+ "fail"
1081
+ ],
1082
+ "description": "return failure or ignore isAlive",
1083
+ "default": "ignore"
1084
+ },
1085
+ "requestFields": {
1086
+ "type": "object",
1087
+ "description": "The json object with response fields of the call to getDevice",
1088
+ "additionalProperties": {
1089
+ "type": "string"
1090
+ },
1091
+ "properties": {}
1092
+ },
1093
+ "responseDatakey": {
1094
+ "type": "string",
1095
+ "description": "place in the response where the data is - supports jsonquery",
1096
+ "default": ""
1097
+ },
1098
+ "responseFields": {
1099
+ "type": "object",
1100
+ "description": "The json object with response fields of the call to isAlive",
1101
+ "additionalProperties": {
1102
+ "type": "string"
1103
+ },
1104
+ "properties": {
1105
+ "status": {
1106
+ "type": "string",
1107
+ "description": "The field in response to isAlive that contains the status of the device",
1108
+ "default": "name"
1109
+ },
1110
+ "statusValue": {
1111
+ "type": "string",
1112
+ "description": "The expected value in the status field",
1113
+ "default": "true"
1114
+ }
1115
+ }
1116
+ }
995
1117
  }
996
1118
  }
997
1119
  },
998
1120
  "getConfig": {
999
- "type": "object",
1000
- "description": "Broker call to getConfig",
1001
- "properties": {
1002
- "path": {
1003
- "type": "string",
1004
- "description": "The fully qualified path of the call to getConfig (e.g. /rest/api/device/{deviceid})",
1005
- "default": ""
1006
- },
1007
- "method": {
1008
- "type": "string",
1009
- "description": "The method of the call to getConfig",
1010
- "default": "GET"
1011
- },
1012
- "query": {
1013
- "type": "string",
1014
- "description": "The stringified json object with query parameters of the call to getConfig",
1015
- "default": "{}"
1016
- },
1017
- "body": {
1018
- "type": "string",
1019
- "description": "The stringified json object with body of the call to getConfig",
1020
- "default": "{}"
1021
- },
1022
- "headers": {
1023
- "type": "string",
1024
- "description": "The stringified json object with headers of the call to getConfig",
1025
- "default": "{}"
1121
+ "type": "array",
1122
+ "description": "Broker call(s) to getConfig",
1123
+ "items": {
1124
+ "properties": {
1125
+ "path": {
1126
+ "type": "string",
1127
+ "description": "The fully qualified path of the call to getConfig (e.g. /rest/api/device/{deviceid})",
1128
+ "default": ""
1129
+ },
1130
+ "method": {
1131
+ "type": "string",
1132
+ "description": "The method of the call to getConfig",
1133
+ "default": "GET"
1134
+ },
1135
+ "query": {
1136
+ "type": "object",
1137
+ "description": "The json object with query parameters of the call to getConfig",
1138
+ "additionalProperties": {
1139
+ "type": "string"
1140
+ }
1141
+ },
1142
+ "body": {
1143
+ "type": "object",
1144
+ "description": "The json object with body of the call to getConfig",
1145
+ "additionalProperties": {
1146
+ "type": "string"
1147
+ }
1148
+ },
1149
+ "headers": {
1150
+ "type": "object",
1151
+ "description": "The json object with headers of the call to getConfig",
1152
+ "additionalProperties": {
1153
+ "type": "string"
1154
+ }
1155
+ },
1156
+ "handleFailure": {
1157
+ "type": "string",
1158
+ "enum": [
1159
+ "ignore",
1160
+ "fail"
1161
+ ],
1162
+ "description": "return failure or ignore getConfig",
1163
+ "default": "ignore"
1164
+ },
1165
+ "requestFields": {
1166
+ "type": "object",
1167
+ "description": "The json object with response fields of the call to getDevice",
1168
+ "additionalProperties": {
1169
+ "type": "string"
1170
+ },
1171
+ "properties": {}
1172
+ },
1173
+ "responseDatakey": {
1174
+ "type": "string",
1175
+ "description": "place in the response where the data is - supports jsonquery",
1176
+ "default": ""
1177
+ },
1178
+ "responseFields": {
1179
+ "type": "object",
1180
+ "description": "The json object with response fields of the call to getConfig",
1181
+ "additionalProperties": {
1182
+ "type": "string"
1183
+ },
1184
+ "properties": {}
1185
+ }
1026
1186
  }
1027
1187
  }
1028
1188
  },
1029
1189
  "getCount": {
1030
- "type": "object",
1031
- "description": "Broker call to getCount",
1032
- "properties": {
1033
- "path": {
1034
- "type": "string",
1035
- "description": "The fully qualified path of the call to getCount (e.g. /rest/api/device)",
1036
- "default": ""
1037
- },
1038
- "method": {
1039
- "type": "string",
1040
- "description": "The method of the call to getCount",
1041
- "default": "GET"
1042
- },
1043
- "query": {
1044
- "type": "string",
1045
- "description": "The stringified json object with query parameters of the call to getCount",
1046
- "default": "{}"
1047
- },
1048
- "body": {
1049
- "type": "string",
1050
- "description": "The stringified json object with body of the call to getCount",
1051
- "default": "{}"
1052
- },
1053
- "headers": {
1054
- "type": "string",
1055
- "description": "The stringified json object with headers of the call to getCount",
1056
- "default": "{}"
1190
+ "type": "array",
1191
+ "description": "Broker call(s) to getCount",
1192
+ "items": {
1193
+ "properties": {
1194
+ "path": {
1195
+ "type": "string",
1196
+ "description": "The fully qualified path of the call to getCount (e.g. /rest/api/device/{deviceid})",
1197
+ "default": ""
1198
+ },
1199
+ "method": {
1200
+ "type": "string",
1201
+ "description": "The method of the call to getCount",
1202
+ "default": "GET"
1203
+ },
1204
+ "query": {
1205
+ "type": "object",
1206
+ "description": "The json object with query parameters of the call to getCount",
1207
+ "additionalProperties": {
1208
+ "type": "string"
1209
+ }
1210
+ },
1211
+ "body": {
1212
+ "type": "object",
1213
+ "description": "The json object with body of the call to getCount",
1214
+ "additionalProperties": {
1215
+ "type": "string"
1216
+ }
1217
+ },
1218
+ "headers": {
1219
+ "type": "object",
1220
+ "description": "The json object with headers of the call to getCount",
1221
+ "additionalProperties": {
1222
+ "type": "string"
1223
+ }
1224
+ },
1225
+ "handleFailure": {
1226
+ "type": "string",
1227
+ "enum": [
1228
+ "ignore",
1229
+ "fail"
1230
+ ],
1231
+ "description": "return failure or ignore getCount",
1232
+ "default": "ignore"
1233
+ },
1234
+ "requestFields": {
1235
+ "type": "object",
1236
+ "description": "The json object with response fields of the call to getDevice",
1237
+ "additionalProperties": {
1238
+ "type": "string"
1239
+ },
1240
+ "properties": {}
1241
+ },
1242
+ "responseDatakey": {
1243
+ "type": "string",
1244
+ "description": "place in the response where the data is - supports jsonquery",
1245
+ "default": ""
1246
+ },
1247
+ "responseFields": {
1248
+ "type": "object",
1249
+ "description": "The json object with response fields of the call to getConfig",
1250
+ "additionalProperties": {
1251
+ "type": "string"
1252
+ },
1253
+ "properties": {}
1254
+ }
1057
1255
  }
1058
1256
  }
1059
1257
  }
package/refs?service=git-upload-pack CHANGED
Binary file