@itentialopensource/adapter-clearcable_noms 0.2.0 → 0.4.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/CALLS.md +227 -22
- package/CHANGELOG.md +16 -0
- package/CONTRIBUTING.md +1 -160
- package/ENHANCE.md +2 -2
- package/README.md +32 -23
- package/adapter.js +185 -357
- package/adapterBase.js +549 -879
- package/changelogs/CHANGELOG.md +8 -0
- package/metadata.json +47 -0
- package/package.json +24 -25
- package/pronghorn.json +980 -641
- package/propertiesSchema.json +432 -32
- package/refs?service=git-upload-pack +0 -0
- package/report/adapter-openapi.json +835 -0
- package/report/adapter-openapi.yaml +712 -0
- package/report/adapterInfo.json +8 -8
- package/report/updateReport1691508928842.json +120 -0
- package/report/updateReport1692202244795.json +120 -0
- package/report/updateReport1692203340166.json +120 -0
- package/report/updateReport1694469507022.json +120 -0
- package/report/updateReport1698423028129.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 +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/CALLS.md
CHANGED
|
@@ -19,7 +19,7 @@ These are adapter methods that IAP or you might use. There are some other method
|
|
|
19
19
|
</tr>
|
|
20
20
|
<tr>
|
|
21
21
|
<td style="padding:15px">healthCheck(callback)</td>
|
|
22
|
-
<td style="padding:15px">This call ensures that the adapter can communicate with
|
|
22
|
+
<td style="padding:15px">This call ensures that the adapter can communicate with Adapter for Clearcable Noms. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
|
|
23
23
|
<td style="padding:15px">No</td>
|
|
24
24
|
</tr>
|
|
25
25
|
<tr>
|
|
@@ -29,7 +29,7 @@ These are adapter methods that IAP or you might use. There are some other method
|
|
|
29
29
|
</tr>
|
|
30
30
|
<tr>
|
|
31
31
|
<td style="padding:15px">encryptProperty(property, technique, callback)</td>
|
|
32
|
-
<td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with
|
|
32
|
+
<td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Adapter for Clearcable Noms.</td>
|
|
33
33
|
<td style="padding:15px">No</td>
|
|
34
34
|
</tr>
|
|
35
35
|
<tr>
|
|
@@ -37,11 +37,6 @@ These are adapter methods that IAP or you might use. There are some other method
|
|
|
37
37
|
<td style="padding:15px">This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.</td>
|
|
38
38
|
<td style="padding:15px">Yes</td>
|
|
39
39
|
</tr>
|
|
40
|
-
<tr>
|
|
41
|
-
<td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
|
|
42
|
-
<td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
|
|
43
|
-
<td style="padding:15px">Yes</td>
|
|
44
|
-
</tr>
|
|
45
40
|
<tr>
|
|
46
41
|
<td style="padding:15px">iapSuspendAdapter(mode, callback)</td>
|
|
47
42
|
<td style="padding:15px">This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.</td>
|
|
@@ -57,12 +52,16 @@ These are adapter methods that IAP or you might use. There are some other method
|
|
|
57
52
|
<td style="padding:15px">This call will return the requests that are waiting in the queue if throttling is enabled.</td>
|
|
58
53
|
<td style="padding:15px">Yes</td>
|
|
59
54
|
</tr>
|
|
55
|
+
<tr>
|
|
56
|
+
<td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
|
|
57
|
+
<td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
|
|
58
|
+
<td style="padding:15px">Yes</td>
|
|
59
|
+
</tr>
|
|
60
60
|
<tr>
|
|
61
61
|
<td style="padding:15px">iapTroubleshootAdapter(props, persistFlag, adapter, callback)</td>
|
|
62
62
|
<td style="padding:15px">This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.</td>
|
|
63
63
|
<td style="padding:15px">Yes</td>
|
|
64
64
|
</tr>
|
|
65
|
-
|
|
66
65
|
<tr>
|
|
67
66
|
<td style="padding:15px">iapRunAdapterHealthcheck(adapter, callback)</td>
|
|
68
67
|
<td style="padding:15px">This call will return the results of a healthcheck.</td>
|
|
@@ -83,6 +82,21 @@ These are adapter methods that IAP or you might use. There are some other method
|
|
|
83
82
|
<td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.</td>
|
|
84
83
|
<td style="padding:15px">Yes</td>
|
|
85
84
|
</tr>
|
|
85
|
+
<tr>
|
|
86
|
+
<td style="padding:15px">iapDeactivateTasks(tasks, callback)</td>
|
|
87
|
+
<td style="padding:15px">This call provides the ability to remove tasks from the adapter.</td>
|
|
88
|
+
<td style="padding:15px">Yes</td>
|
|
89
|
+
</tr>
|
|
90
|
+
<tr>
|
|
91
|
+
<td style="padding:15px">iapActivateTasks(tasks, callback)</td>
|
|
92
|
+
<td style="padding:15px">This call provides the ability to add deactivated tasks back into the adapter.</td>
|
|
93
|
+
<td style="padding:15px">Yes</td>
|
|
94
|
+
</tr>
|
|
95
|
+
<tr>
|
|
96
|
+
<td style="padding:15px">iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback)</td>
|
|
97
|
+
<td style="padding:15px">This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request.</td>
|
|
98
|
+
<td style="padding:15px">Yes</td>
|
|
99
|
+
</tr>
|
|
86
100
|
<tr>
|
|
87
101
|
<td style="padding:15px">genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
|
|
88
102
|
<td style="padding:15px">This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.</td>
|
|
@@ -94,19 +108,42 @@ These are adapter methods that IAP or you might use. There are some other method
|
|
|
94
108
|
<td style="padding:15px">Yes</td>
|
|
95
109
|
</tr>
|
|
96
110
|
<tr>
|
|
97
|
-
<td style="padding:15px">
|
|
98
|
-
<td style="padding:15px">
|
|
99
|
-
<td style="padding:15px">
|
|
111
|
+
<td style="padding:15px">iapRunAdapterLint(callback)</td>
|
|
112
|
+
<td style="padding:15px">Runs lint on the addapter and provides the information back.</td>
|
|
113
|
+
<td style="padding:15px">Yes</td>
|
|
100
114
|
</tr>
|
|
101
115
|
<tr>
|
|
102
|
-
<td style="padding:15px">
|
|
103
|
-
<td style="padding:15px">
|
|
104
|
-
<td style="padding:15px">
|
|
116
|
+
<td style="padding:15px">iapRunAdapterTests(callback)</td>
|
|
117
|
+
<td style="padding:15px">Runs baseunit and unit tests on the adapter and provides the information back.</td>
|
|
118
|
+
<td style="padding:15px">Yes</td>
|
|
105
119
|
</tr>
|
|
106
120
|
<tr>
|
|
107
|
-
<td style="padding:15px">
|
|
108
|
-
<td style="padding:15px">This call
|
|
109
|
-
<td style="padding:15px">
|
|
121
|
+
<td style="padding:15px">iapGetAdapterInventory(callback)</td>
|
|
122
|
+
<td style="padding:15px">This call provides some inventory related information about the adapter.</td>
|
|
123
|
+
<td style="padding:15px">Yes</td>
|
|
124
|
+
</tr>
|
|
125
|
+
</table>
|
|
126
|
+
<br>
|
|
127
|
+
|
|
128
|
+
### Adapter Cache Calls
|
|
129
|
+
|
|
130
|
+
These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well.
|
|
131
|
+
|
|
132
|
+
<table border="1" class="bordered-table">
|
|
133
|
+
<tr>
|
|
134
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
|
|
135
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
|
|
136
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
|
|
137
|
+
</tr>
|
|
138
|
+
<tr>
|
|
139
|
+
<td style="padding:15px">iapPopulateEntityCache(entityTypes, callback)</td>
|
|
140
|
+
<td style="padding:15px">This call populates the adapter cache.</td>
|
|
141
|
+
<td style="padding:15px">Yes</td>
|
|
142
|
+
</tr>
|
|
143
|
+
<tr>
|
|
144
|
+
<td style="padding:15px">iapRetrieveEntitiesCache(entityType, options, callback)</td>
|
|
145
|
+
<td style="padding:15px">This call retrieves the specific items from the adapter cache.</td>
|
|
146
|
+
<td style="padding:15px">Yes</td>
|
|
110
147
|
</tr>
|
|
111
148
|
</table>
|
|
112
149
|
<br>
|
|
@@ -129,27 +166,27 @@ These are adapter methods that are used to integrate to IAP Brokers. This adapte
|
|
|
129
166
|
<tr>
|
|
130
167
|
<td style="padding:15px">getDevice(deviceName, callback)</td>
|
|
131
168
|
<td style="padding:15px">This call returns the details of the requested device.</td>
|
|
132
|
-
<td style="padding:15px">
|
|
169
|
+
<td style="padding:15px">No</td>
|
|
133
170
|
</tr>
|
|
134
171
|
<tr>
|
|
135
172
|
<td style="padding:15px">getDevicesFiltered(options, callback)</td>
|
|
136
173
|
<td style="padding:15px">This call returns the list of devices that match the criteria provided in the options filter.</td>
|
|
137
|
-
<td style="padding:15px">
|
|
174
|
+
<td style="padding:15px">No</td>
|
|
138
175
|
</tr>
|
|
139
176
|
<tr>
|
|
140
177
|
<td style="padding:15px">isAlive(deviceName, callback)</td>
|
|
141
178
|
<td style="padding:15px">This call returns whether the device status is active</td>
|
|
142
|
-
<td style="padding:15px">
|
|
179
|
+
<td style="padding:15px">No</td>
|
|
143
180
|
</tr>
|
|
144
181
|
<tr>
|
|
145
182
|
<td style="padding:15px">getConfig(deviceName, format, callback)</td>
|
|
146
183
|
<td style="padding:15px">This call returns the configuration for the selected device.</td>
|
|
147
|
-
<td style="padding:15px">
|
|
184
|
+
<td style="padding:15px">No</td>
|
|
148
185
|
</tr>
|
|
149
186
|
<tr>
|
|
150
187
|
<td style="padding:15px">iapGetDeviceCount(callback)</td>
|
|
151
188
|
<td style="padding:15px">This call returns the count of devices.</td>
|
|
152
|
-
<td style="padding:15px">
|
|
189
|
+
<td style="padding:15px">No</td>
|
|
153
190
|
</tr>
|
|
154
191
|
</table>
|
|
155
192
|
<br>
|
|
@@ -165,5 +202,173 @@ Specific adapter calls are built based on the API of the Clearcable Network Oper
|
|
|
165
202
|
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th>
|
|
166
203
|
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
|
|
167
204
|
</tr>
|
|
205
|
+
<tr>
|
|
206
|
+
<td style="padding:15px">getCableModemRealTimeData(macAddress, callback)</td>
|
|
207
|
+
<td style="padding:15px">Get Cable Modem Real Time Data</td>
|
|
208
|
+
<td style="padding:15px">{base_path}/{version}/read/realtimedata/{pathv1}?{query}</td>
|
|
209
|
+
<td style="padding:15px">Yes</td>
|
|
210
|
+
</tr>
|
|
211
|
+
<tr>
|
|
212
|
+
<td style="padding:15px">getMacsWithHourlyData(callback)</td>
|
|
213
|
+
<td style="padding:15px">Get All MACs with Hourly Data</td>
|
|
214
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_transfer/v0.1/list_macs/hourly?{query}</td>
|
|
215
|
+
<td style="padding:15px">Yes</td>
|
|
216
|
+
</tr>
|
|
217
|
+
<tr>
|
|
218
|
+
<td style="padding:15px">getMacWithHourlyData(macAddress, callback)</td>
|
|
219
|
+
<td style="padding:15px">Get MAC with Hourly Data</td>
|
|
220
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_transfer/v0.1/hourly/mac/{pathv1}?{query}</td>
|
|
221
|
+
<td style="padding:15px">Yes</td>
|
|
222
|
+
</tr>
|
|
223
|
+
<tr>
|
|
224
|
+
<td style="padding:15px">getMacWithMonthlyData(macAddress, callback)</td>
|
|
225
|
+
<td style="padding:15px">Get MAC with Monthly Data</td>
|
|
226
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_transfer/v0.1/monthly/mac/{pathv1}?{query}</td>
|
|
227
|
+
<td style="padding:15px">Yes</td>
|
|
228
|
+
</tr>
|
|
229
|
+
<tr>
|
|
230
|
+
<td style="padding:15px">getSumOfTransfersInCurrentMonth(macAddress, callback)</td>
|
|
231
|
+
<td style="padding:15px">Get Sum of Transfers Current Month</td>
|
|
232
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_transfer/v0.1/this_month_sum/mac/{pathv1}?{query}</td>
|
|
233
|
+
<td style="padding:15px">Yes</td>
|
|
234
|
+
</tr>
|
|
235
|
+
<tr>
|
|
236
|
+
<td style="padding:15px">getMACsTransferredMostCurrentMonth(limit, callback)</td>
|
|
237
|
+
<td style="padding:15px">Get MACs Transferred Most Current Month</td>
|
|
238
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_transfer/v0.1/top_this_month/{pathv1}?{query}</td>
|
|
239
|
+
<td style="padding:15px">Yes</td>
|
|
240
|
+
</tr>
|
|
241
|
+
<tr>
|
|
242
|
+
<td style="padding:15px">getSumTransfersInMonthForEachMac(date, callback)</td>
|
|
243
|
+
<td style="padding:15px">Get Sum of Transfers by Month</td>
|
|
244
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_transfer/v0.1/sum_per_mac_in_month/{pathv1}?{query}</td>
|
|
245
|
+
<td style="padding:15px">Yes</td>
|
|
246
|
+
</tr>
|
|
247
|
+
<tr>
|
|
248
|
+
<td style="padding:15px">getSumTransfersInMonthForEachMacCount(date, callback)</td>
|
|
249
|
+
<td style="padding:15px">Get Sum of Transfers by Month Count</td>
|
|
250
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_transfer/v0.1/sum_per_mac_in_month/{pathv1}/count?{query}</td>
|
|
251
|
+
<td style="padding:15px">Yes</td>
|
|
252
|
+
</tr>
|
|
253
|
+
<tr>
|
|
254
|
+
<td style="padding:15px">getSumTransfersInMonthForEachMacSortTotal(date, callback)</td>
|
|
255
|
+
<td style="padding:15px">Get Sum of Transfers by Month Sort Total</td>
|
|
256
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_transfer/v0.1/sum_per_mac_in_month/{pathv1}/sort/total?{query}</td>
|
|
257
|
+
<td style="padding:15px">Yes</td>
|
|
258
|
+
</tr>
|
|
259
|
+
<tr>
|
|
260
|
+
<td style="padding:15px">getSumTransfersInMonthForEachMacSortUpload(date, callback)</td>
|
|
261
|
+
<td style="padding:15px">Get Sum of Transfers by Month Sort Upload</td>
|
|
262
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_transfer/v0.1/sum_per_mac_in_month/{pathv1}/sort/upload?{query}</td>
|
|
263
|
+
<td style="padding:15px">Yes</td>
|
|
264
|
+
</tr>
|
|
265
|
+
<tr>
|
|
266
|
+
<td style="padding:15px">getSumTransfersInMonthForEachMacSortDownload(date, callback)</td>
|
|
267
|
+
<td style="padding:15px">Get Sum of Transfers by Month Sort Download</td>
|
|
268
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_transfer/v0.1/sum_per_mac_in_month/{pathv1}/sort/download?{query}</td>
|
|
269
|
+
<td style="padding:15px">Yes</td>
|
|
270
|
+
</tr>
|
|
271
|
+
<tr>
|
|
272
|
+
<td style="padding:15px">getSumTransfersInMonthForEachMacLimit(date, limitStart, limitCount, callback)</td>
|
|
273
|
+
<td style="padding:15px">Get Sum of Transfers by Month Limit</td>
|
|
274
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_transfer/v0.1/sum_per_mac_in_month/{pathv1}/limit/{pathv2}/{pathv3}?{query}</td>
|
|
275
|
+
<td style="padding:15px">Yes</td>
|
|
276
|
+
</tr>
|
|
277
|
+
<tr>
|
|
278
|
+
<td style="padding:15px">getSumServices(date, callback)</td>
|
|
279
|
+
<td style="padding:15px">Get Services by Month</td>
|
|
280
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_transfer/v0.1/list_services_in_month/{pathv1}?{query}</td>
|
|
281
|
+
<td style="padding:15px">Yes</td>
|
|
282
|
+
</tr>
|
|
283
|
+
<tr>
|
|
284
|
+
<td style="padding:15px">getAllCableModemHourly(callback)</td>
|
|
285
|
+
<td style="padding:15px">Get All Cable Modems Hourly</td>
|
|
286
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_rf/v0.1/list_macs/hourly?{query}</td>
|
|
287
|
+
<td style="padding:15px">Yes</td>
|
|
288
|
+
</tr>
|
|
289
|
+
<tr>
|
|
290
|
+
<td style="padding:15px">getCableModemHourly(macAddress, callback)</td>
|
|
291
|
+
<td style="padding:15px">Get Cable Modem Hourly</td>
|
|
292
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_rf/v0.1/hourly/mac/{pathv1}?{query}</td>
|
|
293
|
+
<td style="padding:15px">Yes</td>
|
|
294
|
+
</tr>
|
|
295
|
+
<tr>
|
|
296
|
+
<td style="padding:15px">getCableModemDailyMac(macAddress, callback)</td>
|
|
297
|
+
<td style="padding:15px">Get Cable Modem Daily</td>
|
|
298
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_rf/v0.1/daily/mac/{pathv1}?{query}</td>
|
|
299
|
+
<td style="padding:15px">Yes</td>
|
|
300
|
+
</tr>
|
|
301
|
+
<tr>
|
|
302
|
+
<td style="padding:15px">getCableModemMonthly(macAddress, callback)</td>
|
|
303
|
+
<td style="padding:15px">Get Cable Modem Monthly</td>
|
|
304
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_rf/v0.1/monthly/mac/{pathv1}?{query}</td>
|
|
305
|
+
<td style="padding:15px">Yes</td>
|
|
306
|
+
</tr>
|
|
307
|
+
<tr>
|
|
308
|
+
<td style="padding:15px">getCableModemCurrentMonthAverage(macAddress, callback)</td>
|
|
309
|
+
<td style="padding:15px">Get Cable Modem Current Month Average</td>
|
|
310
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_rf/v0.1/this_month_average/mac/{pathv1}?{query}</td>
|
|
311
|
+
<td style="padding:15px">Yes</td>
|
|
312
|
+
</tr>
|
|
313
|
+
<tr>
|
|
314
|
+
<td style="padding:15px">getCableModemAverageMac(date, callback)</td>
|
|
315
|
+
<td style="padding:15px">Get Cable Modem Average MAC</td>
|
|
316
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_transfer/v0.1/average_per_mac_in_month/{pathv1}?{query}</td>
|
|
317
|
+
<td style="padding:15px">Yes</td>
|
|
318
|
+
</tr>
|
|
319
|
+
<tr>
|
|
320
|
+
<td style="padding:15px">getAllCableModemFlapHourly(callback)</td>
|
|
321
|
+
<td style="padding:15px">Get All Cable Modem Flaps Hourly</td>
|
|
322
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_flap/v0.1/list_macs/hourly?{query}</td>
|
|
323
|
+
<td style="padding:15px">Yes</td>
|
|
324
|
+
</tr>
|
|
325
|
+
<tr>
|
|
326
|
+
<td style="padding:15px">getCableModemFlapHourly(macAddress, callback)</td>
|
|
327
|
+
<td style="padding:15px">Get Cable Modem Flaps Hourly</td>
|
|
328
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_flap/v0.1/list_macs/hourly/{pathv1}?{query}</td>
|
|
329
|
+
<td style="padding:15px">Yes</td>
|
|
330
|
+
</tr>
|
|
331
|
+
<tr>
|
|
332
|
+
<td style="padding:15px">getCableModemFlapDaily(macAddress, callback)</td>
|
|
333
|
+
<td style="padding:15px">Get Cable Modem Flaps Daily</td>
|
|
334
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_flap/v0.1/daily/mac/{pathv1}?{query}</td>
|
|
335
|
+
<td style="padding:15px">Yes</td>
|
|
336
|
+
</tr>
|
|
337
|
+
<tr>
|
|
338
|
+
<td style="padding:15px">getCableModemFlapMonthly(macAddress, callback)</td>
|
|
339
|
+
<td style="padding:15px">Get Cable Modem Flaps Monthly</td>
|
|
340
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_flap/v0.1/monthly/mac/{pathv1}?{query}</td>
|
|
341
|
+
<td style="padding:15px">Yes</td>
|
|
342
|
+
</tr>
|
|
343
|
+
<tr>
|
|
344
|
+
<td style="padding:15px">getCableModemFlapCurrentDay(macAddress, callback)</td>
|
|
345
|
+
<td style="padding:15px">Get Cable Modem Flaps Current Day</td>
|
|
346
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_flap/v0.1/this_day_sum/mac/{pathv1}?{query}</td>
|
|
347
|
+
<td style="padding:15px">Yes</td>
|
|
348
|
+
</tr>
|
|
349
|
+
<tr>
|
|
350
|
+
<td style="padding:15px">getCableModemFlapCurrentMonth(macAddress, callback)</td>
|
|
351
|
+
<td style="padding:15px">Get Cable Modem Flaps Current Month</td>
|
|
352
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_flap/v0.1/this_month_sum/mac/{pathv1}?{query}</td>
|
|
353
|
+
<td style="padding:15px">Yes</td>
|
|
354
|
+
</tr>
|
|
355
|
+
<tr>
|
|
356
|
+
<td style="padding:15px">getCableModemFlapLastMonth(macAddress, callback)</td>
|
|
357
|
+
<td style="padding:15px">Get Cable Modem Flaps Last Month</td>
|
|
358
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_flap/v0.1/last_month_sum/mac/{pathv1}?{query}</td>
|
|
359
|
+
<td style="padding:15px">Yes</td>
|
|
360
|
+
</tr>
|
|
361
|
+
<tr>
|
|
362
|
+
<td style="padding:15px">getCableModemFlapCurrentMonthMost(limit, callback)</td>
|
|
363
|
+
<td style="padding:15px">Get Cable Modem Flaps Current Month Most</td>
|
|
364
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_flap/v0.1/top_this_hour/{pathv1}?{query}</td>
|
|
365
|
+
<td style="padding:15px">Yes</td>
|
|
366
|
+
</tr>
|
|
367
|
+
<tr>
|
|
368
|
+
<td style="padding:15px">getCableModemStatus(macAddress, callback)</td>
|
|
369
|
+
<td style="padding:15px">Get Cable Modem Status</td>
|
|
370
|
+
<td style="padding:15px">{base_path}/{version}/read/cablemodem_status/v0.1/mac/{pathv1}?{query}</td>
|
|
371
|
+
<td style="padding:15px">Yes</td>
|
|
372
|
+
</tr>
|
|
168
373
|
</table>
|
|
169
374
|
<br>
|
package/CHANGELOG.md
CHANGED
|
@@ -1,4 +1,20 @@
|
|
|
1
1
|
|
|
2
|
+
## 0.4.0 [01-05-2024]
|
|
3
|
+
|
|
4
|
+
* Minor/2023 auto migration
|
|
5
|
+
|
|
6
|
+
See merge request itentialopensource/adapters/telemetry-analytics/adapter-clearcable_noms!3
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## 0.3.0 [01-03-2024]
|
|
11
|
+
|
|
12
|
+
* Adapter Engine has been updated and the changes are being migrated to the adapter
|
|
13
|
+
|
|
14
|
+
See merge request itentialopensource/adapters/telemetry-analytics/adapter-clearcable_noms!2
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
2
18
|
## 0.2.0 [05-27-2022]
|
|
3
19
|
|
|
4
20
|
* Migration to the latest Adapter Foundation
|
package/CONTRIBUTING.md
CHANGED
|
@@ -10,163 +10,4 @@ This project and everyone participating in it is governed by the Code of Conduct
|
|
|
10
10
|
|
|
11
11
|
## How to Contribute
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
This section guides you through submitting a bug report. Following these guidelines helps maintainers understand your report :pencil:, reproduce the behavior :computer: :left_right_arrow: :computer:, and find related reports :mag_right:.
|
|
16
|
-
|
|
17
|
-
Before creating bug reports, please check before-submitting-a-bug-report, as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. If you have an Itential support contract, please create an Itential Service Desk ticket. If you don't have an Itential support contract, please send an email of the issue to support@itential.com.
|
|
18
|
-
|
|
19
|
-
#### Before Submitting A Bug Report
|
|
20
|
-
|
|
21
|
-
* **Check the README.md.** You might be able to find the cause of the problem and fix things yourself. Most importantly, check if you can reproduce the problem __in the latest version__.
|
|
22
|
-
* **Work through the troubleshooting process.** Troubleshooting will include changing the log level of Itential Automation Platform (IAP) and adapters and checking the logs to see what the issues are. These logs should be included in any ticket you open for this issue.
|
|
23
|
-
* **Check for resolutions to the issue.** Check the <a href="https://itential.atlassian.net/servicedesk/customer/kb/view/286883841?applicationId=605994d2-2cb2-3174-af59-ed5b23ff5fd5&spaceKey=PKB&src=1187380921" target="_blank">Itential Knowledge Base</a> to see if there is a known resolution for the issue you are having.
|
|
24
|
-
* **Ask around in chat if you are an Itential employee** to see if others are experiencing the same issue.
|
|
25
|
-
|
|
26
|
-
#### How to Submit a (Good) Bug Report
|
|
27
|
-
|
|
28
|
-
Bugs are tracked through the Itential Service Desk. Explain the problem and include additional details to help maintainers reproduce the problem:
|
|
29
|
-
|
|
30
|
-
- **Use a clear and descriptive title** for the issue to identify the problem.
|
|
31
|
-
- **Describe the exact steps which reproduce the problem** in as much detail as possible. For example, start by explaining how you configured the adapter (e.g., which properties you used and how they were set) or how you are using an artifact.
|
|
32
|
-
- **Provide specific examples to demonstrate the steps**. Include logs, or copy/paste snippets, in your examples.
|
|
33
|
-
- **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
|
|
34
|
-
- **Explain which behavior you expected to see instead and why.**
|
|
35
|
-
- **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. You can use <a href="https://www.cockos.com/licecap/" target="_blank">this tool</a> to record GIFs on macOS and Windows. Use <a href="https://github.com/colinkeenan/silentcast" target="_blank">this tool</a> or <a href="https://github.com/rhcarvalho/byzanz-guiz" target="_blank">program</a> on Linux.
|
|
36
|
-
- **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
|
|
37
|
-
|
|
38
|
-
Provide more context by answering these questions:
|
|
39
|
-
|
|
40
|
-
- **Did the problem start happening recently** (e.g. after updating to a new version/tag) or was this always a problem?
|
|
41
|
-
- If the problem started happening recently, **can you reproduce the problem in an older version/tag?** What's the most recent version in which the problem does not happen?
|
|
42
|
-
- **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
|
|
43
|
-
|
|
44
|
-
Include details about your configuration and environment:
|
|
45
|
-
|
|
46
|
-
- **Which version of the adapter/artifact are you using?** You can get the exact version by checking the project version in the package.json file.
|
|
47
|
-
- **What's the name and version of the OS you're using**?
|
|
48
|
-
- **Are you running or using IAP in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and guest?
|
|
49
|
-
- **Are there firewalls between IAP and any other system you are integrating with?** If so, have you tried running curl from the system IAP is on to the other system to verify you have connectivity between the systems?
|
|
50
|
-
|
|
51
|
-
### Your First Code Contribution
|
|
52
|
-
|
|
53
|
-
#### Local development
|
|
54
|
-
|
|
55
|
-
This project can be developed locally on all operating systems. For instructions on how to do this, follow the steps highlighted in the README.md. The README.mdprovides many more details on cloning the repository for local development, how to lint and test your changes.
|
|
56
|
-
|
|
57
|
-
#### Development Process
|
|
58
|
-
|
|
59
|
-
The following provides a local copy of the repository along with dependencies.
|
|
60
|
-
|
|
61
|
-
```json
|
|
62
|
-
go to the repository you are interested in working on
|
|
63
|
-
click on the Clone button to get the link(s) you can use to clone the repository
|
|
64
|
-
git clone <link to clone the project>
|
|
65
|
-
npm install
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
Prior to making changes you should create a branch to work in. The branch should be named with the type of change (major, minor or patch) and then a Jira issue number or a description of the issue.
|
|
69
|
-
|
|
70
|
-
```json
|
|
71
|
-
git checkout -b <name_of_your_new_branch>
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
Make all of the desired changes.
|
|
75
|
-
|
|
76
|
-
> **Note:** All code changes should be accompanied by additional Unit and Integration tests to minimize the likelihood that any changes will negatively impact the adapter/artifact as well as to ensure the desired functionality is achieved.
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
<table border="1" class="bordered-table">
|
|
80
|
-
<tr>
|
|
81
|
-
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Files</span></th>
|
|
82
|
-
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Changes</span></th>
|
|
83
|
-
</tr>
|
|
84
|
-
<tr>
|
|
85
|
-
<td style="padding:15px">.codeclimate.yml, .eslintignore, .eslintrc.js, .gitignore, .gitlab-ci.yml, .jshintrc, .npmignore</td>
|
|
86
|
-
<td style="padding:15px">These are foundational files that are used in linting and building of the adapter. Changes to these files are heavily scrutinized and may be implemented in a different manner so that the changes can be implemented across all adapters.</td>
|
|
87
|
-
</tr>
|
|
88
|
-
<tr>
|
|
89
|
-
<td style="padding:15px">CODE_OF_CONDUCT.md, CONTRIBUTING.md, LICENSE, README.md</td>
|
|
90
|
-
<td style="padding:15px">These are license and process files for the repository. Changes to these files may require legal review and may also be implemented in a different manner so that the changes can be implemented across all adapters.</td>
|
|
91
|
-
</tr>
|
|
92
|
-
<tr>
|
|
93
|
-
<td style="padding:15px">utils/*, adapterBase.js</td>
|
|
94
|
-
<td style="padding:15px">Changes to these files will rarely be accepted. These are process files that need to be changed through the builder process and migration.</td>
|
|
95
|
-
</tr>
|
|
96
|
-
<tr>
|
|
97
|
-
<td style="padding:15px">adapter.js</td>
|
|
98
|
-
<td style="padding:15px">Changes to this file are code changes. They should be accompanied by the appropriate unit and integration tests. If new methods are added, they should also be added to the pronghorn.json file, otherwise integration tests are likely to fail.</td>
|
|
99
|
-
</tr>
|
|
100
|
-
<tr>
|
|
101
|
-
<td style="padding:15px">error.json, propertiesSchema.json</td>
|
|
102
|
-
<td style="padding:15px">These files are utilized by the Itential Runtime libraries. You can make changes to these files, but the changes should be appending of new errors or properties. Removal of errors and properties can result in rejection of the changes.</td>
|
|
103
|
-
</tr>
|
|
104
|
-
<tr>
|
|
105
|
-
<td style="padding:15px">pacakge.json, package-lock.json</td>
|
|
106
|
-
<td style="padding:15px">The package-lock.json is automatically generated and should only be updated when the dependencies inside of the package.json are modified. You can make changes to the package.json to add additional scripts, add new dependencies, modify names, etc. However, changing the scripts or dependencies that are Itential specific will be overriden during the acceptance process.</td>
|
|
107
|
-
</tr>
|
|
108
|
-
<tr>
|
|
109
|
-
<td style="padding:15px">pronghorn.json</td>
|
|
110
|
-
<td style="padding:15px">Changes to this file are made for integration into IAP. The most common change here is adding new methods that shoud be exposed to the IAP Workflow.</td>
|
|
111
|
-
</tr>
|
|
112
|
-
<tr>
|
|
113
|
-
<td style="padding:15px">entities/*</td>
|
|
114
|
-
<td style="padding:15px">Changes to these files include adding new capabilities, updating existing capabilities, or removing deprecated capabilities in the adapter. Translation configuration can also be modified here.</td>
|
|
115
|
-
</tr>
|
|
116
|
-
<tr>
|
|
117
|
-
<td style="padding:15px">test/*</td>
|
|
118
|
-
<td style="padding:15px">Changes to these files include adding, updating, or removing unit and integration tests in the adapter. Tests should never be removed unless the methods that are being tested are removed also. Both the unit and integration test file should have a marker that identifies where modification can take place. Modifications above that marker are likely to be rejected or implemented in a different manner.</td>
|
|
119
|
-
</tr>
|
|
120
|
-
</table>
|
|
121
|
-
<br>
|
|
122
|
-
|
|
123
|
-
> **Note:** It is a best practice to lint and test your code prior to committing changes into the repository. You can lint your code by running **npm run lint** and test it by running **node utils/testRunner.sh**. However, there are pre-commit hooks that will run these scripts when you commit your changes.
|
|
124
|
-
|
|
125
|
-
Commit the changes to the repository.
|
|
126
|
-
|
|
127
|
-
```json
|
|
128
|
-
git commit -a -m "<descriptive message>"
|
|
129
|
-
```
|
|
130
|
-
|
|
131
|
-
> **Note:** There are pre-commit hooks in place. If the pre-commit hooks fail, you will need to address those issues before moving forward.
|
|
132
|
-
|
|
133
|
-
Push the changes into the repository. This should only be done after the commit has successfully completed.
|
|
134
|
-
|
|
135
|
-
```json
|
|
136
|
-
git push origin <name_of_your_new_branch>
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
Create a Merge Request.
|
|
140
|
-
|
|
141
|
-
### Merge Requests
|
|
142
|
-
|
|
143
|
-
- Fill out the provided merge request template.
|
|
144
|
-
- Reference related issues and merge requests liberally.
|
|
145
|
-
- Include screenshots and animated GIFs in your merge request whenever possible.
|
|
146
|
-
- Follow the project Styleguide.
|
|
147
|
-
- End all files with a newline.
|
|
148
|
-
|
|
149
|
-
## Styleguide
|
|
150
|
-
|
|
151
|
-
### Git Commit Messages
|
|
152
|
-
|
|
153
|
-
- Use the present tense ("Add feature" not "Added feature")
|
|
154
|
-
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
|
|
155
|
-
- Consider starting the commit message with an applicable emoji _(not required)_:
|
|
156
|
-
- :art: `:art:` When improving the format/structure of the code.
|
|
157
|
-
- :racehorse: `:racehorse:` When improving performance
|
|
158
|
-
- :non-potable_water: `:non-potable_water:` When plugging memory leaks.
|
|
159
|
-
- :memo: `:memo:` When writing documentation.
|
|
160
|
-
- :penguin: `:penguin:` When fixing something on Linux.
|
|
161
|
-
- :apple: `:apple:` When fixing something on macOS.
|
|
162
|
-
- :checkered_flag: `:checkered_flag:` When fixing something on Windows.
|
|
163
|
-
- :bug: `:bug:` When fixing a bug.
|
|
164
|
-
- :fire: `:fire:` When removing code or files.
|
|
165
|
-
- :green_heart: `:green_heart:` When fixing the CI build.
|
|
166
|
-
- :white_check_mark: `:white_check_mark:` When adding tests,
|
|
167
|
-
- :lock: `:lock:` When dealing with security.
|
|
168
|
-
- :arrow_up: `:arrow_up:` When upgrading dependencies.
|
|
169
|
-
- :arrow_down: `:arrow_down:` When downgrading dependencies.
|
|
170
|
-
- :shirt: `:shirt:` When removing linter warnings.
|
|
171
|
-
|
|
172
|
-
__Avoid installing unnecessary packages.__ Do not install packages just because they might be "nice to have". Itential Opensource projects are supposed to be minimal, specific, and compact by design.
|
|
13
|
+
Follow the contributing guide (here)[https://gitlab.com/itentialopensource/adapters/contributing-guide]
|
package/ENHANCE.md
CHANGED
|
@@ -18,7 +18,7 @@ npm run adapter:update
|
|
|
18
18
|
|
|
19
19
|
If you do not have a Swagger or OpenAPI document, you can use a Postman Collection and convert that to an OpenAPI document using APIMatic and then follow the first process.
|
|
20
20
|
|
|
21
|
-
If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and, in order to make it available as a workflow task in IAP, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the <a href="https://
|
|
21
|
+
If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and, in order to make it available as a workflow task in IAP, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a> on our Documentation Site.
|
|
22
22
|
|
|
23
23
|
```text
|
|
24
24
|
Files to update
|
|
@@ -66,4 +66,4 @@ Files to update
|
|
|
66
66
|
* test/integration/adapterTestIntegration.js: add better data for the create and update calls so that they will not fail.
|
|
67
67
|
```
|
|
68
68
|
|
|
69
|
-
As mentioned previously, for most of these changes as well as other possible changes, there is more information on how to work on an adapter in the <a href="https://
|
|
69
|
+
As mentioned previously, for most of these changes as well as other possible changes, there is more information on how to work on an adapter in the <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a> on our Documentation Site.
|