@itentialopensource/adapter-paragon_pathfinder 1.2.8 → 1.3.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.
Files changed (43) hide show
  1. package/.eslintignore +0 -1
  2. package/.jshintrc +3 -0
  3. package/CALLS.md +144 -212
  4. package/CHANGELOG.md +8 -0
  5. package/CONTRIBUTING.md +1 -160
  6. package/ENHANCE.md +2 -2
  7. package/README.md +31 -22
  8. package/adapter.js +163 -334
  9. package/adapterBase.js +538 -873
  10. package/changelogs/changelog.md +96 -0
  11. package/metadata.json +47 -0
  12. package/package.json +22 -25
  13. package/pronghorn.json +474 -209
  14. package/propertiesSchema.json +451 -39
  15. package/refs?service=git-upload-pack +0 -0
  16. package/report/adapter-openapi.json +69945 -0
  17. package/report/adapter-openapi.yaml +74294 -0
  18. package/report/adapterInfo.json +8 -8
  19. package/report/updateReport1691507543487.json +120 -0
  20. package/report/updateReport1692202561721.json +120 -0
  21. package/report/updateReport1694461665971.json +120 -0
  22. package/report/updateReport1698420920735.json +120 -0
  23. package/sampleProperties.json +63 -2
  24. package/test/integration/adapterTestBasicGet.js +1 -1
  25. package/test/integration/adapterTestConnectivity.js +91 -42
  26. package/test/integration/adapterTestIntegration.js +130 -2
  27. package/test/unit/adapterBaseTestUnit.js +388 -315
  28. package/test/unit/adapterTestUnit.js +306 -109
  29. package/utils/adapterInfo.js +1 -1
  30. package/utils/addAuth.js +1 -1
  31. package/utils/artifactize.js +1 -1
  32. package/utils/checkMigrate.js +1 -1
  33. package/utils/entitiesToDB.js +1 -0
  34. package/utils/findPath.js +1 -1
  35. package/utils/methodDocumentor.js +71 -23
  36. package/utils/modify.js +13 -15
  37. package/utils/packModificationScript.js +1 -1
  38. package/utils/taskMover.js +309 -0
  39. package/utils/tbScript.js +3 -10
  40. package/utils/tbUtils.js +2 -3
  41. package/utils/testRunner.js +1 -1
  42. package/utils/troubleshootingAdapter.js +1 -3
  43. package/workflows/README.md +0 -3
package/CALLS.md CHANGED
@@ -168,457 +168,427 @@ Specific adapter calls are built based on the API of the Paragon_pathfinder. The
168
168
  </tr>
169
169
  <tr>
170
170
  <td style="padding:15px">getTopologyV2(callback)</td>
171
- <td style="padding:15px">Returns a list of the topologies that are available.</td>
171
+ <td style="padding:15px">Get List of Topologies</td>
172
172
  <td style="padding:15px">{base_path}/{version}/topology/v2?{query}</td>
173
173
  <td style="padding:15px">Yes</td>
174
174
  </tr>
175
175
  <tr>
176
176
  <td style="padding:15px">getTopologyV2TopologyId(topologyId, callback)</td>
177
- <td style="padding:15px">Lists topological elements
178
- </td>
177
+ <td style="padding:15px">Get Topological Elements</td>
179
178
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}?{query}</td>
180
179
  <td style="padding:15px">Yes</td>
181
180
  </tr>
182
181
  <tr>
183
182
  <td style="padding:15px">deleteTopologyV2TopologyId(topologyId, callback)</td>
184
- <td style="padding:15px">Deletes all of the topology planned data. The information acquired through BGP-LS reappears immediately.</td>
183
+ <td style="padding:15px">Delete the Topology</td>
185
184
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}?{query}</td>
186
185
  <td style="padding:15px">Yes</td>
187
186
  </tr>
188
187
  <tr>
189
188
  <td style="padding:15px">getTopologyV2TopologyIdStream(topologyId, callback)</td>
190
- <td style="padding:15px">See</td>
189
+ <td style="padding:15px">Start a SSE Stream</td>
191
190
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/stream?{query}</td>
192
191
  <td style="padding:15px">Yes</td>
193
192
  </tr>
194
193
  <tr>
195
194
  <td style="padding:15px">getTopologyV2TopologyIdStatus(topologyId, callback)</td>
196
- <td style="padding:15px">Returns the status of all Paragon PathFinder components.</td>
195
+ <td style="padding:15px">Get Paragon PathFinder Component Status</td>
197
196
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/status?{query}</td>
198
197
  <td style="padding:15px">Yes</td>
199
198
  </tr>
200
199
  <tr>
201
200
  <td style="padding:15px">getTopologyV2TopologyIdStatusAnalyticsCollection(topologyId, callback)</td>
202
- <td style="padding:15px">Returns the status of the analytics data collection.</td>
201
+ <td style="padding:15px">Get Analytics Data Collection Component Status</td>
203
202
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/status/analyticsCollection?{query}</td>
204
203
  <td style="padding:15px">Yes</td>
205
204
  </tr>
206
205
  <tr>
207
206
  <td style="padding:15px">getTopologyV2TopologyIdStatusAnalyticsDatabase(topologyId, callback)</td>
208
- <td style="padding:15px">Returns the status of the analytics data collection database.</td>
207
+ <td style="padding:15px">Get Analytics Data Collection Database Status</td>
209
208
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/status/analyticsDatabase?{query}</td>
210
209
  <td style="padding:15px">Yes</td>
211
210
  </tr>
212
211
  <tr>
213
212
  <td style="padding:15px">getTopologyV2TopologyIdStatusPce(topologyId, callback)</td>
214
- <td style="padding:15px">Returns the status of the PCEP protocol adapter component.</td>
213
+ <td style="padding:15px">Get PCEP Protocol Adapter Status</td>
215
214
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/status/pce?{query}</td>
216
215
  <td style="padding:15px">Yes</td>
217
216
  </tr>
218
217
  <tr>
219
218
  <td style="padding:15px">getTopologyV2TopologyIdStatusTopologyAcquisition(topologyId, callback)</td>
220
- <td style="padding:15px">Returns the status of the Network Topology Acquisition Daemon (NTAD, BGP-LSP protocol adapter) component.</td>
219
+ <td style="padding:15px">Get BGP-LS Protocol Adapter Status</td>
221
220
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/status/topologyAcquisition?{query}</td>
222
221
  <td style="padding:15px">Yes</td>
223
222
  </tr>
224
223
  <tr>
225
224
  <td style="padding:15px">getTopologyV2TopologyIdStatusPathComputationServer(topologyId, callback)</td>
226
- <td style="padding:15px">Returns the status of the Path Computation Server component.</td>
225
+ <td style="padding:15px">Get Path Computation Server Status</td>
227
226
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/status/pathComputationServer?{query}</td>
228
227
  <td style="padding:15px">Yes</td>
229
228
  </tr>
230
229
  <tr>
231
230
  <td style="padding:15px">getTopologyV2TopologyIdStatusTransportTopologyAcquisition(topologyId, callback)</td>
232
- <td style="padding:15px">Returns the status of the Transport Network Topology Acquisition Daemon.</td>
231
+ <td style="padding:15px">Get Transport Topology Acquisition Daemon Status</td>
233
232
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/status/transportTopologyAcquisition?{query}</td>
234
233
  <td style="padding:15px">Yes</td>
235
234
  </tr>
236
235
  <tr>
237
236
  <td style="padding:15px">getTopologyV2TopologyIdNodes(topologyId, callback)</td>
238
- <td style="padding:15px">Returns a full list of nodes.</td>
237
+ <td style="padding:15px">Get Nodes</td>
239
238
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/nodes?{query}</td>
240
239
  <td style="padding:15px">Yes</td>
241
240
  </tr>
242
241
  <tr>
243
242
  <td style="padding:15px">postTopologyV2TopologyIdNodes(topologyId, body, callback)</td>
244
- <td style="padding:15px">Creates a node using the following schema:
245
- </td>
243
+ <td style="padding:15px">Create a Node</td>
246
244
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/nodes?{query}</td>
247
245
  <td style="padding:15px">Yes</td>
248
246
  </tr>
249
247
  <tr>
250
248
  <td style="padding:15px">getTopologyV2TopologyIdNodesSearch(topologyId, queryData, callback)</td>
251
- <td style="padding:15px">Searches the list of nodes for specific URI parameters. For example, search?name=62.0.0.101 must return one node.</td>
249
+ <td style="padding:15px">Search Nodes</td>
252
250
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/nodes/search?{query}</td>
253
251
  <td style="padding:15px">Yes</td>
254
252
  </tr>
255
253
  <tr>
256
254
  <td style="padding:15px">getTopologyV2TopologyIdNodesStream(topologyId, callback)</td>
257
- <td style="padding:15px">See</td>
255
+ <td style="padding:15px">Start a SSE Stream</td>
258
256
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/nodes/stream?{query}</td>
259
257
  <td style="padding:15px">Yes</td>
260
258
  </tr>
261
259
  <tr>
262
260
  <td style="padding:15px">postTopologyV2TopologyIdNodesBulk(topologyId, body, callback)</td>
263
- <td style="padding:15px">Creates several Nodes using the following JSON schema:
264
- </td>
261
+ <td style="padding:15px">Create a List of Nodes</td>
265
262
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/nodes/bulk?{query}</td>
266
263
  <td style="padding:15px">Yes</td>
267
264
  </tr>
268
265
  <tr>
269
266
  <td style="padding:15px">putTopologyV2TopologyIdNodesBulk(topologyId, body, callback)</td>
270
- <td style="padding:15px">Updates several Nodes using the following JSON schema:
271
- </td>
267
+ <td style="padding:15px">Update a List of Nodes</td>
272
268
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/nodes/bulk?{query}</td>
273
269
  <td style="padding:15px">Yes</td>
274
270
  </tr>
275
271
  <tr>
276
272
  <td style="padding:15px">patchTopologyV2TopologyIdNodesBulk(topologyId, body, callback)</td>
277
- <td style="padding:15px">Updates several Nodes using the
278
- following JSON schema:</td>
273
+ <td style="padding:15px">Update a List of Nodes using PATCH</td>
279
274
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/nodes/bulk?{query}</td>
280
275
  <td style="padding:15px">Yes</td>
281
276
  </tr>
282
277
  <tr>
283
278
  <td style="padding:15px">deleteTopologyV2TopologyIdNodesBulk(topologyId, callback)</td>
284
- <td style="padding:15px">Deletes a list of Nodess. The payload must conform to</td>
279
+ <td style="padding:15px">Delete a List of Nodes</td>
285
280
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/nodes/bulk?{query}</td>
286
281
  <td style="padding:15px">Yes</td>
287
282
  </tr>
288
283
  <tr>
289
284
  <td style="padding:15px">getTopologyV2TopologyIdNodesNodeIndex(topologyId, nodeIndex, callback)</td>
290
- <td style="padding:15px">Returns details for a node.</td>
285
+ <td style="padding:15px">Get a Single Node</td>
291
286
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/nodes/{pathv2}?{query}</td>
292
287
  <td style="padding:15px">Yes</td>
293
288
  </tr>
294
289
  <tr>
295
290
  <td style="padding:15px">putTopologyV2TopologyIdNodesNodeIndex(topologyId, nodeIndex, body, callback)</td>
296
- <td style="padding:15px">Updates a node using the following schema:
297
- </td>
291
+ <td style="padding:15px">Update Node Properties</td>
298
292
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/nodes/{pathv2}?{query}</td>
299
293
  <td style="padding:15px">Yes</td>
300
294
  </tr>
301
295
  <tr>
302
296
  <td style="padding:15px">patchTopologyV2TopologyIdNodesNodeIndex(topologyId, nodeIndex, body, callback)</td>
303
- <td style="padding:15px">Updates a node using a RFC6902 patch:
304
- </td>
297
+ <td style="padding:15px">Patch Node</td>
305
298
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/nodes/{pathv2}?{query}</td>
306
299
  <td style="padding:15px">Yes</td>
307
300
  </tr>
308
301
  <tr>
309
302
  <td style="padding:15px">deleteTopologyV2TopologyIdNodesNodeIndex(topologyId, nodeIndex, callback)</td>
310
- <td style="padding:15px">Deletes a node. (You cannot delete a live node; it reappears on the next update from Topology server.)</td>
303
+ <td style="padding:15px">Delete a Node</td>
311
304
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/nodes/{pathv2}?{query}</td>
312
305
  <td style="padding:15px">Yes</td>
313
306
  </tr>
314
307
  <tr>
315
308
  <td style="padding:15px">getTopologyV2TopologyIdNodesNodeIndexHistory(topologyId, nodeIndex, callback)</td>
316
- <td style="padding:15px">Returns the event history for a node.</td>
309
+ <td style="padding:15px">Get the Node Event History</td>
317
310
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/nodes/{pathv2}/history?{query}</td>
318
311
  <td style="padding:15px">Yes</td>
319
312
  </tr>
320
313
  <tr>
321
314
  <td style="padding:15px">getTopologyV2TopologyIdNodesNodeIndexUser(topologyId, nodeIndex, callback)</td>
322
- <td style="padding:15px">>Returns the information configured via REST for a node.</td>
315
+ <td style="padding:15px">Get the node user-defined information</td>
323
316
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/nodes/{pathv2}/user?{query}</td>
324
317
  <td style="padding:15px">Yes</td>
325
318
  </tr>
326
319
  <tr>
327
320
  <td style="padding:15px">getTopologyV2TopologyIdNodesNodeIndexBgpLs(topologyId, nodeIndex, callback)</td>
328
- <td style="padding:15px">Returns the node data live data information.</td>
321
+ <td style="padding:15px">Get the bgp-ls node information</td>
329
322
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/nodes/{pathv2}/bgp-ls?{query}</td>
330
323
  <td style="padding:15px">Yes</td>
331
324
  </tr>
332
325
  <tr>
333
326
  <td style="padding:15px">getTopologyV2TopologyIdNodesNodeIndexDevice(topologyId, nodeIndex, callback)</td>
334
- <td style="padding:15px">Returns the information retrieved using NETCONF for a link.</td>
327
+ <td style="padding:15px">Get the link device information</td>
335
328
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/nodes/{pathv2}/device?{query}</td>
336
329
  <td style="padding:15px">Yes</td>
337
330
  </tr>
338
331
  <tr>
339
332
  <td style="padding:15px">getTopologyV2TopologyIdLinks(topologyId, callback)</td>
340
- <td style="padding:15px">Returns a full list of links.</td>
333
+ <td style="padding:15px">Get Links</td>
341
334
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/links?{query}</td>
342
335
  <td style="padding:15px">Yes</td>
343
336
  </tr>
344
337
  <tr>
345
338
  <td style="padding:15px">postTopologyV2TopologyIdLinks(topologyId, body, callback)</td>
346
- <td style="padding:15px">Creates a link using optional and required parameters defined in the following schema:
347
- </td>
339
+ <td style="padding:15px">Create a Link</td>
348
340
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/links?{query}</td>
349
341
  <td style="padding:15px">Yes</td>
350
342
  </tr>
351
343
  <tr>
352
344
  <td style="padding:15px">getTopologyV2TopologyIdLinksStream(topologyId, callback)</td>
353
- <td style="padding:15px">See</td>
345
+ <td style="padding:15px">Start a SSE Stream</td>
354
346
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/links/stream?{query}</td>
355
347
  <td style="padding:15px">Yes</td>
356
348
  </tr>
357
349
  <tr>
358
350
  <td style="padding:15px">getTopologyV2TopologyIdLinksUtilization(topologyId, callback)</td>
359
- <td style="padding:15px">Returns a list of links only containing the endA/endZ utilization</td>
351
+ <td style="padding:15px">Get Links utilization only</td>
360
352
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/links/utilization?{query}</td>
361
353
  <td style="padding:15px">Yes</td>
362
354
  </tr>
363
355
  <tr>
364
356
  <td style="padding:15px">getTopologyV2TopologyIdLinksSearch(topologyId, queryData, callback)</td>
365
- <td style="padding:15px">Searches the link list based on URI parameters. For example, search?name=62.101.105 must return one Link.</td>
357
+ <td style="padding:15px">Search Links</td>
366
358
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/links/search?{query}</td>
367
359
  <td style="padding:15px">Yes</td>
368
360
  </tr>
369
361
  <tr>
370
362
  <td style="padding:15px">getTopologyV2TopologyIdLinksLinkIndex(topologyId, linkIndex, callback)</td>
371
- <td style="padding:15px">Returns the details for a link.</td>
363
+ <td style="padding:15px">Get a Single Link</td>
372
364
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/links/{pathv2}?{query}</td>
373
365
  <td style="padding:15px">Yes</td>
374
366
  </tr>
375
367
  <tr>
376
368
  <td style="padding:15px">putTopologyV2TopologyIdLinksLinkIndex(topologyId, linkIndex, body, callback)</td>
377
- <td style="padding:15px">Updates a planned link using the optional and required parameters defined in the following schema:
378
- </td>
369
+ <td style="padding:15px">Update Link</td>
379
370
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/links/{pathv2}?{query}</td>
380
371
  <td style="padding:15px">Yes</td>
381
372
  </tr>
382
373
  <tr>
383
374
  <td style="padding:15px">patchTopologyV2TopologyIdLinksLinkIndex(topologyId, linkIndex, body, callback)</td>
384
- <td style="padding:15px">Updates a link using a RFC6902 patch:
385
- </td>
375
+ <td style="padding:15px">Patch Link</td>
386
376
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/links/{pathv2}?{query}</td>
387
377
  <td style="padding:15px">Yes</td>
388
378
  </tr>
389
379
  <tr>
390
380
  <td style="padding:15px">deleteTopologyV2TopologyIdLinksLinkIndex(topologyId, linkIndex, callback)</td>
391
- <td style="padding:15px">Deletes a link. Live links reappear on the next update from the Topology server.</td>
381
+ <td style="padding:15px">Delete a Link</td>
392
382
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/links/{pathv2}?{query}</td>
393
383
  <td style="padding:15px">Yes</td>
394
384
  </tr>
395
385
  <tr>
396
386
  <td style="padding:15px">getTopologyV2TopologyIdLinksLinkIndexHistory(topologyId, linkIndex, callback)</td>
397
- <td style="padding:15px">Returns the history for a Link.</td>
387
+ <td style="padding:15px">Get the Link Event History</td>
398
388
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/links/{pathv2}/history?{query}</td>
399
389
  <td style="padding:15px">Yes</td>
400
390
  </tr>
401
391
  <tr>
402
392
  <td style="padding:15px">getTopologyV2TopologyIdLinksLinkIndexDevice(topologyId, linkIndex, callback)</td>
403
- <td style="padding:15px">Returns the information retrieved using NETCONF for a link.</td>
393
+ <td style="padding:15px">Get the link device information</td>
404
394
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/links/{pathv2}/device?{query}</td>
405
395
  <td style="padding:15px">Yes</td>
406
396
  </tr>
407
397
  <tr>
408
398
  <td style="padding:15px">putTopologyV2TopologyIdLinksLinkIndexDevice(topologyId, linkIndex, body, callback)</td>
409
- <td style="padding:15px">Updates a link in the device itself (i.e NETCONF). The provisioning accepts a limited set of parameters, described in
410
- </td>
399
+ <td style="padding:15px">Update Link</td>
411
400
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/links/{pathv2}/device?{query}</td>
412
401
  <td style="padding:15px">Yes</td>
413
402
  </tr>
414
403
  <tr>
415
404
  <td style="padding:15px">patchTopologyV2TopologyIdLinksLinkIndexDevice(topologyId, linkIndex, body, callback)</td>
416
- <td style="padding:15px">Updates a link using a RFC6902 patch:
417
- </td>
405
+ <td style="padding:15px">Patch Link</td>
418
406
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/links/{pathv2}/device?{query}</td>
419
407
  <td style="padding:15px">Yes</td>
420
408
  </tr>
421
409
  <tr>
422
410
  <td style="padding:15px">getTopologyV2TopologyIdLinksLinkIndexUser(topologyId, linkIndex, callback)</td>
423
- <td style="padding:15px">Returns the information configured via REST for a link.</td>
411
+ <td style="padding:15px">Get the link user-defined information</td>
424
412
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/links/{pathv2}/user?{query}</td>
425
413
  <td style="padding:15px">Yes</td>
426
414
  </tr>
427
415
  <tr>
428
416
  <td style="padding:15px">putTopologyV2TopologyIdLinksLinkIndexUser(topologyId, linkIndex, body, callback)</td>
429
- <td style="padding:15px">Updates a link using the optional and required parameters defined in the following schema:
430
- </td>
417
+ <td style="padding:15px">Update Link</td>
431
418
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/links/{pathv2}/user?{query}</td>
432
419
  <td style="padding:15px">Yes</td>
433
420
  </tr>
434
421
  <tr>
435
422
  <td style="padding:15px">patchTopologyV2TopologyIdLinksLinkIndexUser(topologyId, linkIndex, body, callback)</td>
436
- <td style="padding:15px">Updates a link user-defined attributes using a RFC6902 patch:
437
- </td>
423
+ <td style="padding:15px">Patch Link</td>
438
424
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/links/{pathv2}/user?{query}</td>
439
425
  <td style="padding:15px">Yes</td>
440
426
  </tr>
441
427
  <tr>
442
428
  <td style="padding:15px">getTopologyV2TopologyIdLinksLinkIndexBgpLs(topologyId, linkIndex, callback)</td>
443
- <td style="padding:15px">Returns the information discovered using BGP-LS.</td>
429
+ <td style="padding:15px">Get the link Live information</td>
444
430
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/links/{pathv2}/bgp-ls?{query}</td>
445
431
  <td style="padding:15px">Yes</td>
446
432
  </tr>
447
433
  <tr>
448
434
  <td style="padding:15px">getTopologyV2TopologyIdTeLsps(topologyId, callback)</td>
449
- <td style="padding:15px">Returns the TE-LSP list.</td>
435
+ <td style="padding:15px">Get TE-LSPs</td>
450
436
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-lsps?{query}</td>
451
437
  <td style="padding:15px">Yes</td>
452
438
  </tr>
453
439
  <tr>
454
440
  <td style="padding:15px">postTopologyV2TopologyIdTeLsps(topologyId, body, callback)</td>
455
- <td style="padding:15px">Creates a TE-LSP using the following JSON schema:
456
- </td>
441
+ <td style="padding:15px">Create a TE-LSP</td>
457
442
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-lsps?{query}</td>
458
443
  <td style="padding:15px">Yes</td>
459
444
  </tr>
460
445
  <tr>
461
446
  <td style="padding:15px">getTopologyV2TopologyIdTeLspsSearch(topologyId, queryData, callback)</td>
462
- <td style="padding:15px">Performs a search in the LSP list based on the URI parameters. For example, "search?name=62.101.105" returns one link.</td>
447
+ <td style="padding:15px">Search LSPs</td>
463
448
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-lsps/search?{query}</td>
464
449
  <td style="padding:15px">Yes</td>
465
450
  </tr>
466
451
  <tr>
467
452
  <td style="padding:15px">getTopologyV2TopologyIdTeLspsStream(topologyId, callback)</td>
468
- <td style="padding:15px">See</td>
453
+ <td style="padding:15px">Start a SSE Stream</td>
469
454
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-lsps/stream?{query}</td>
470
455
  <td style="padding:15px">Yes</td>
471
456
  </tr>
472
457
  <tr>
473
458
  <td style="padding:15px">postTopologyV2TopologyIdTeLspsBulk(topologyId, body, callback)</td>
474
- <td style="padding:15px">Creates several TE-LSPs using the following JSON schema:
475
- </td>
459
+ <td style="padding:15px">Create a List of TE-LSPs</td>
476
460
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-lsps/bulk?{query}</td>
477
461
  <td style="padding:15px">Yes</td>
478
462
  </tr>
479
463
  <tr>
480
464
  <td style="padding:15px">putTopologyV2TopologyIdTeLspsBulk(topologyId, body, callback)</td>
481
- <td style="padding:15px">Updates several TE-LSPs using the following JSON schema:
482
- </td>
465
+ <td style="padding:15px">Update a List of TE-LSPs</td>
483
466
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-lsps/bulk?{query}</td>
484
467
  <td style="padding:15px">Yes</td>
485
468
  </tr>
486
469
  <tr>
487
470
  <td style="padding:15px">patchTopologyV2TopologyIdTeLspsBulk(topologyId, body, callback)</td>
488
- <td style="padding:15px">Updates several TE-LSPs using the
489
- following JSON schema:</td>
471
+ <td style="padding:15px">Update a List of TE-LSPs using PATCH</td>
490
472
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-lsps/bulk?{query}</td>
491
473
  <td style="padding:15px">Yes</td>
492
474
  </tr>
493
475
  <tr>
494
476
  <td style="padding:15px">deleteTopologyV2TopologyIdTeLspsBulk(topologyId, callback)</td>
495
- <td style="padding:15px">Deletes a list of TE-LSPs. This function
496
- is supported only on the PCE-initiated LSPs. PCC-controlled and
497
- PCC-delegated LSPs cannot be deleted from Paragon PathFinder. They must
498
- be deleted in the node.b The payload must conform to</td>
477
+ <td style="padding:15px">Delete a List of TE-LSPs</td>
499
478
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-lsps/bulk?{query}</td>
500
479
  <td style="padding:15px">Yes</td>
501
480
  </tr>
502
481
  <tr>
503
482
  <td style="padding:15px">getTopologyV2TopologyIdTeLspsLspIndex(topologyId, lspIndex, callback)</td>
504
- <td style="padding:15px">Returns the details for a TE-LSP.</td>
483
+ <td style="padding:15px">Get a Single TE-LSP</td>
505
484
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-lsps/{pathv2}?{query}</td>
506
485
  <td style="padding:15px">Yes</td>
507
486
  </tr>
508
487
  <tr>
509
488
  <td style="padding:15px">putTopologyV2TopologyIdTeLspsLspIndex(topologyId, lspIndex, body, callback)</td>
510
- <td style="padding:15px">Updates a TE-LSP using the JSON schema:
511
- </td>
489
+ <td style="padding:15px">Update a TE-LSP</td>
512
490
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-lsps/{pathv2}?{query}</td>
513
491
  <td style="padding:15px">Yes</td>
514
492
  </tr>
515
493
  <tr>
516
494
  <td style="padding:15px">patchTopologyV2TopologyIdTeLspsLspIndex(topologyId, lspIndex, body, callback)</td>
517
- <td style="padding:15px">Updates a TE-LSP using a RFC6902 patch:
518
- </td>
495
+ <td style="padding:15px">Patch a TE-LSP</td>
519
496
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-lsps/{pathv2}?{query}</td>
520
497
  <td style="padding:15px">Yes</td>
521
498
  </tr>
522
499
  <tr>
523
500
  <td style="padding:15px">deleteTopologyV2TopologyIdTeLspsLspIndex(topologyId, lspIndex, callback)</td>
524
- <td style="padding:15px">Deletes a TE-LSP. This function is supported only on the PCE-initiated LSPs. PCC-controlled and PCC-delegated LSPs cannot be deleted from Paragon PathFinder. They must be deleted in the node.</td>
501
+ <td style="padding:15px">Delete a TE-LSP</td>
525
502
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-lsps/{pathv2}?{query}</td>
526
503
  <td style="padding:15px">Yes</td>
527
504
  </tr>
528
505
  <tr>
529
506
  <td style="padding:15px">getTopologyV2TopologyIdTeLspsLspIndexHistory(topologyId, lspIndex, callback)</td>
530
- <td style="padding:15px">Returns the history for a TE-LSP.</td>
507
+ <td style="padding:15px">Get the LSP Event History</td>
531
508
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-lsps/{pathv2}/history?{query}</td>
532
509
  <td style="padding:15px">Yes</td>
533
510
  </tr>
534
511
  <tr>
535
512
  <td style="padding:15px">getTopologyV2TopologyIdDemands(topologyId, callback)</td>
536
- <td style="padding:15px">Returns a full list of Demands.</td>
513
+ <td style="padding:15px">Gets all Demands</td>
537
514
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/demands?{query}</td>
538
515
  <td style="padding:15px">Yes</td>
539
516
  </tr>
540
517
  <tr>
541
518
  <td style="padding:15px">postTopologyV2TopologyIdDemands(topologyId, body, callback)</td>
542
- <td style="padding:15px">Create a demand using the following JSON schema:
543
- </td>
519
+ <td style="padding:15px">Create a Demand</td>
544
520
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/demands?{query}</td>
545
521
  <td style="padding:15px">Yes</td>
546
522
  </tr>
547
523
  <tr>
548
524
  <td style="padding:15px">getTopologyV2TopologyIdDemandsStream(topologyId, callback)</td>
549
- <td style="padding:15px">See</td>
525
+ <td style="padding:15px">Start a SSE Stream</td>
550
526
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/demands/stream?{query}</td>
551
527
  <td style="padding:15px">Yes</td>
552
528
  </tr>
553
529
  <tr>
554
530
  <td style="padding:15px">getTopologyV2TopologyIdDemandsDemandIndex(topologyId, demandIndex, callback)</td>
555
- <td style="padding:15px">Return the details of a specified demand.</td>
531
+ <td style="padding:15px">Get a Specific Demand</td>
556
532
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/demands/{pathv2}?{query}</td>
557
533
  <td style="padding:15px">Yes</td>
558
534
  </tr>
559
535
  <tr>
560
536
  <td style="padding:15px">putTopologyV2TopologyIdDemandsDemandIndex(topologyId, demandIndex, body, callback)</td>
561
- <td style="padding:15px">Modify a specific demand using the following JSON schema:
562
- </td>
537
+ <td style="padding:15px">Update a Specific Demand</td>
563
538
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/demands/{pathv2}?{query}</td>
564
539
  <td style="padding:15px">Yes</td>
565
540
  </tr>
566
541
  <tr>
567
542
  <td style="padding:15px">patchTopologyV2TopologyIdDemandsDemandIndex(topologyId, demandIndex, body, callback)</td>
568
- <td style="padding:15px">Patch a specific demand using a RFC6902 patch:
569
- </td>
543
+ <td style="padding:15px">Update a Specific Demand using PATCH</td>
570
544
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/demands/{pathv2}?{query}</td>
571
545
  <td style="padding:15px">Yes</td>
572
546
  </tr>
573
547
  <tr>
574
548
  <td style="padding:15px">deleteTopologyV2TopologyIdDemandsDemandIndex(topologyId, demandIndex, callback)</td>
575
- <td style="padding:15px">Delete a specific demand.</td>
549
+ <td style="padding:15px">Delete a Specific Demand</td>
576
550
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/demands/{pathv2}?{query}</td>
577
551
  <td style="padding:15px">Yes</td>
578
552
  </tr>
579
553
  <tr>
580
554
  <td style="padding:15px">postTopologyV2TopologyIdDemandsBulk(topologyId, body, callback)</td>
581
- <td style="padding:15px">Create a set of demands using the following JSON schema:
582
- </td>
555
+ <td style="padding:15px">Create a set of Demands</td>
583
556
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/demands/bulk?{query}</td>
584
557
  <td style="padding:15px">Yes</td>
585
558
  </tr>
586
559
  <tr>
587
560
  <td style="padding:15px">putTopologyV2TopologyIdDemandsBulk(topologyId, body, callback)</td>
588
- <td style="padding:15px">Update a set of demands using the following JSON schema:
589
- </td>
561
+ <td style="padding:15px">Update a set of Demands</td>
590
562
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/demands/bulk?{query}</td>
591
563
  <td style="padding:15px">Yes</td>
592
564
  </tr>
593
565
  <tr>
594
566
  <td style="padding:15px">patchTopologyV2TopologyIdDemandsBulk(topologyId, body, callback)</td>
595
- <td style="padding:15px">Patch a set of demands using the following JSON schema:
596
- </td>
567
+ <td style="padding:15px">Patch a set of Demands</td>
597
568
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/demands/bulk?{query}</td>
598
569
  <td style="padding:15px">Yes</td>
599
570
  </tr>
600
571
  <tr>
601
572
  <td style="padding:15px">deleteTopologyV2TopologyIdDemandsBulk(topologyId, callback)</td>
602
- <td style="padding:15px">Delete a set of demands. The return code indicates the request acceptance.</td>
573
+ <td style="padding:15px">Delete a set of Demands</td>
603
574
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/demands/bulk?{query}</td>
604
575
  <td style="padding:15px">Yes</td>
605
576
  </tr>
606
577
  <tr>
607
578
  <td style="padding:15px">getTopologyV2TopologyIdP2mp(topologyId, callback)</td>
608
- <td style="padding:15px">Returns a full list of P2MP groups.</td>
579
+ <td style="padding:15px">Get P2MP groups</td>
609
580
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/p2mp?{query}</td>
610
581
  <td style="padding:15px">Yes</td>
611
582
  </tr>
612
583
  <tr>
613
584
  <td style="padding:15px">postTopologyV2TopologyIdP2mp(topologyId, body, callback)</td>
614
- <td style="padding:15px">Create a P2MP group using the following schema:
615
- </td>
585
+ <td style="padding:15px">Create a P2MP group</td>
616
586
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/p2mp?{query}</td>
617
587
  <td style="padding:15px">Yes</td>
618
588
  </tr>
619
589
  <tr>
620
590
  <td style="padding:15px">getTopologyV2TopologyIdP2mpStream(topologyId, callback)</td>
621
- <td style="padding:15px">See</td>
591
+ <td style="padding:15px">Start a SSE Stream</td>
622
592
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/p2mp/stream?{query}</td>
623
593
  <td style="padding:15px">Yes</td>
624
594
  </tr>
@@ -630,15 +600,13 @@ Specific adapter calls are built based on the API of the Paragon_pathfinder. The
630
600
  </tr>
631
601
  <tr>
632
602
  <td style="padding:15px">getTopologyV2TopologyIdP2mpP2mpGroupIndex(topologyId, p2mpGroupIndex, callback)</td>
633
- <td style="padding:15px">Returns the details of a specified P2MP group.</td>
603
+ <td style="padding:15px">Get a Specific P2MP Group</td>
634
604
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/p2mp/{pathv2}?{query}</td>
635
605
  <td style="padding:15px">Yes</td>
636
606
  </tr>
637
607
  <tr>
638
608
  <td style="padding:15px">putTopologyV2TopologyIdP2mpP2mpGroupIndex(topologyId, p2mpGroupIndex, body, callback)</td>
639
- <td style="padding:15px">Modify a specific P2MP group, if the LSPS are not specified, the common properties are changed, not the LSPs.
640
- If the LSPs are specified, the set of LSPs will be modified. i.e LSP that is not in the new list will be remove,
641
- the other will be added/updated".</td>
609
+ <td style="padding:15px">Update a Specific P2MP Group</td>
642
610
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/p2mp/{pathv2}?{query}</td>
643
611
  <td style="padding:15px">Yes</td>
644
612
  </tr>
@@ -650,23 +618,19 @@ Specific adapter calls are built based on the API of the Paragon_pathfinder. The
650
618
  </tr>
651
619
  <tr>
652
620
  <td style="padding:15px">patchTopologyV2TopologyIdP2mpP2mpGroupIndex(topologyId, p2mpGroupIndex, body, callback)</td>
653
- <td style="padding:15px">Modify a specific P2MP group using a PATCH document (RFC6906). The operation has the same behavior as the PUT method. An empty PATCH will re-provision the complete tree.</td>
621
+ <td style="padding:15px">Update a Specific P2MP Group using a PATCH document</td>
654
622
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/p2mp/{pathv2}?{query}</td>
655
623
  <td style="padding:15px">Yes</td>
656
624
  </tr>
657
625
  <tr>
658
626
  <td style="padding:15px">postTopologyV2TopologyIdP2mpP2mpGroupIndex(topologyId, p2mpGroupIndex, body, callback)</td>
659
- <td style="padding:15px">The POST URL accepts a list
660
- of new leaves. Use the following schema to
661
- create a P2MP leaf:
662
- </td>
627
+ <td style="padding:15px">Create a P2MP Leaf</td>
663
628
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/p2mp/{pathv2}?{query}</td>
664
629
  <td style="padding:15px">Yes</td>
665
630
  </tr>
666
631
  <tr>
667
632
  <td style="padding:15px">getTopologyV2TopologyIdP2mpP2mpGroupIndexLspIndex(topologyId, p2mpGroupIndex, lspIndex, callback)</td>
668
- <td style="padding:15px">Returns the details of
669
- a specified P2MP leaf.</td>
633
+ <td style="padding:15px">Get a Specific P2MP Leaf</td>
670
634
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/p2mp/{pathv2}/{pathv3}?{query}</td>
671
635
  <td style="padding:15px">Yes</td>
672
636
  </tr>
@@ -684,441 +648,409 @@ Specific adapter calls are built based on the API of the Paragon_pathfinder. The
684
648
  </tr>
685
649
  <tr>
686
650
  <td style="padding:15px">getTopologyV2TopologyIdVrfs(topologyId, callback)</td>
687
- <td style="padding:15px">Returns the list of VRF
688
- summary: which node have vrf information and how
689
- many vrf are present.</td>
651
+ <td style="padding:15px">Get the nodes with VRF</td>
690
652
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/vrfs?{query}</td>
691
653
  <td style="padding:15px">Yes</td>
692
654
  </tr>
693
655
  <tr>
694
656
  <td style="padding:15px">getTopologyV2TopologyIdVrfsNodeIndex(topologyId, nodeIndex, callback)</td>
695
- <td style="padding:15px">Returns the list of
696
- discovered VRF for that node.</td>
657
+ <td style="padding:15px">List the VRF on a given node</td>
697
658
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/vrfs/{pathv2}?{query}</td>
698
659
  <td style="padding:15px">Yes</td>
699
660
  </tr>
700
661
  <tr>
701
662
  <td style="padding:15px">getTopologyV2TopologyIdMaintenances(topologyId, callback)</td>
702
- <td style="padding:15px">Returns a full list of Maintenance.</td>
663
+ <td style="padding:15px">Get Maintenance</td>
703
664
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/maintenances?{query}</td>
704
665
  <td style="padding:15px">Yes</td>
705
666
  </tr>
706
667
  <tr>
707
668
  <td style="padding:15px">postTopologyV2TopologyIdMaintenances(topologyId, body, callback)</td>
708
- <td style="padding:15px">Create a new maintenance using the following schema:
709
- </td>
669
+ <td style="padding:15px">Create a new maintenance</td>
710
670
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/maintenances?{query}</td>
711
671
  <td style="padding:15px">Yes</td>
712
672
  </tr>
713
673
  <tr>
714
674
  <td style="padding:15px">getTopologyV2TopologyIdMaintenancesStream(topologyId, callback)</td>
715
- <td style="padding:15px">See</td>
675
+ <td style="padding:15px">Start a SSE Stream</td>
716
676
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/maintenances/stream?{query}</td>
717
677
  <td style="padding:15px">Yes</td>
718
678
  </tr>
719
679
  <tr>
720
680
  <td style="padding:15px">getTopologyV2TopologyIdMaintenancesMaintenanceIndex(topologyId, maintenanceIndex, callback)</td>
721
- <td style="padding:15px">Returns the details of a specified maintenance.</td>
681
+ <td style="padding:15px">Get a Specific Maintenance</td>
722
682
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/maintenances/{pathv2}?{query}</td>
723
683
  <td style="padding:15px">Yes</td>
724
684
  </tr>
725
685
  <tr>
726
686
  <td style="padding:15px">putTopologyV2TopologyIdMaintenancesMaintenanceIndex(topologyId, maintenanceIndex, body, callback)</td>
727
- <td style="padding:15px">Modify a specific maintenance.</td>
687
+ <td style="padding:15px">Update a Specific Maintenance</td>
728
688
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/maintenances/{pathv2}?{query}</td>
729
689
  <td style="padding:15px">Yes</td>
730
690
  </tr>
731
691
  <tr>
732
692
  <td style="padding:15px">deleteTopologyV2TopologyIdMaintenancesMaintenanceIndex(topologyId, maintenanceIndex, callback)</td>
733
- <td style="padding:15px">Delete a specific maintenance.</td>
693
+ <td style="padding:15px">Delete a Specific Maintenance</td>
734
694
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/maintenances/{pathv2}?{query}</td>
735
695
  <td style="padding:15px">Yes</td>
736
696
  </tr>
737
697
  <tr>
738
698
  <td style="padding:15px">getTopologyV2TopologyIdFacilities(topologyId, callback)</td>
739
- <td style="padding:15px">Gets all Facilities.</td>
699
+ <td style="padding:15px">Get all facilities</td>
740
700
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/facilities?{query}</td>
741
701
  <td style="padding:15px">Yes</td>
742
702
  </tr>
743
703
  <tr>
744
704
  <td style="padding:15px">postTopologyV2TopologyIdFacilities(topologyId, body, callback)</td>
745
- <td style="padding:15px">Creates a facility.</td>
705
+ <td style="padding:15px">Create a facilities</td>
746
706
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/facilities?{query}</td>
747
707
  <td style="padding:15px">Yes</td>
748
708
  </tr>
749
709
  <tr>
750
710
  <td style="padding:15px">getTopologyV2TopologyIdFacilitiesStream(topologyId, callback)</td>
751
- <td style="padding:15px">See</td>
711
+ <td style="padding:15px">Start a SSE Stream</td>
752
712
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/facilities/stream?{query}</td>
753
713
  <td style="padding:15px">Yes</td>
754
714
  </tr>
755
715
  <tr>
756
716
  <td style="padding:15px">getTopologyV2TopologyIdFacilitiesFacilityIndex(topologyId, facilityIndex, callback)</td>
757
- <td style="padding:15px">Gets a Facility.</td>
717
+ <td style="padding:15px">Get one facility</td>
758
718
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/facilities/{pathv2}?{query}</td>
759
719
  <td style="padding:15px">Yes</td>
760
720
  </tr>
761
721
  <tr>
762
722
  <td style="padding:15px">putTopologyV2TopologyIdFacilitiesFacilityIndex(topologyId, facilityIndex, body, callback)</td>
763
- <td style="padding:15px">Updates a facility</td>
723
+ <td style="padding:15px">Update a facility</td>
764
724
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/facilities/{pathv2}?{query}</td>
765
725
  <td style="padding:15px">Yes</td>
766
726
  </tr>
767
727
  <tr>
768
728
  <td style="padding:15px">deleteTopologyV2TopologyIdFacilitiesFacilityIndex(topologyId, facilityIndex, callback)</td>
769
- <td style="padding:15px">Deletes a facility.</td>
729
+ <td style="padding:15px">Delete the facility</td>
770
730
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/facilities/{pathv2}?{query}</td>
771
731
  <td style="padding:15px">Yes</td>
772
732
  </tr>
773
733
  <tr>
774
734
  <td style="padding:15px">getTopologyV2TopologyIdTeContainers(topologyId, callback)</td>
775
- <td style="padding:15px">List all TE-containers.</td>
735
+ <td style="padding:15px">Get all TE Containers</td>
776
736
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-containers?{query}</td>
777
737
  <td style="padding:15px">Yes</td>
778
738
  </tr>
779
739
  <tr>
780
740
  <td style="padding:15px">postTopologyV2TopologyIdTeContainers(topologyId, body, callback)</td>
781
- <td style="padding:15px">Creates a container.</td>
741
+ <td style="padding:15px">Create a new te-container</td>
782
742
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-containers?{query}</td>
783
743
  <td style="padding:15px">Yes</td>
784
744
  </tr>
785
745
  <tr>
786
746
  <td style="padding:15px">getTopologyV2TopologyIdTeContainersStream(topologyId, callback)</td>
787
- <td style="padding:15px">See</td>
747
+ <td style="padding:15px">Start a SSE Stream</td>
788
748
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-containers/stream?{query}</td>
789
749
  <td style="padding:15px">Yes</td>
790
750
  </tr>
791
751
  <tr>
792
752
  <td style="padding:15px">getTopologyV2TopologyIdTeContainersContainerIndex(topologyId, containerIndex, callback)</td>
793
- <td style="padding:15px">Gets a TE Container.</td>
753
+ <td style="padding:15px">Get one te-container</td>
794
754
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-containers/{pathv2}?{query}</td>
795
755
  <td style="padding:15px">Yes</td>
796
756
  </tr>
797
757
  <tr>
798
758
  <td style="padding:15px">putTopologyV2TopologyIdTeContainersContainerIndex(topologyId, containerIndex, body, callback)</td>
799
- <td style="padding:15px">Updates a TE Container</td>
759
+ <td style="padding:15px">Update the te-container</td>
800
760
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-containers/{pathv2}?{query}</td>
801
761
  <td style="padding:15px">Yes</td>
802
762
  </tr>
803
763
  <tr>
804
764
  <td style="padding:15px">patchTopologyV2TopologyIdTeContainersContainerIndex(topologyId, containerIndex, body, callback)</td>
805
- <td style="padding:15px">Updates a TE Container
806
- using an RFC6902 document</td>
765
+ <td style="padding:15px">Update te-container</td>
807
766
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-containers/{pathv2}?{query}</td>
808
767
  <td style="padding:15px">Yes</td>
809
768
  </tr>
810
769
  <tr>
811
770
  <td style="padding:15px">deleteTopologyV2TopologyIdTeContainersContainerIndex(topologyId, containerIndex, callback)</td>
812
- <td style="padding:15px">Deletes a
813
- container.</td>
771
+ <td style="padding:15px">delete thete-container</td>
814
772
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-containers/{pathv2}?{query}</td>
815
773
  <td style="padding:15px">Yes</td>
816
774
  </tr>
817
775
  <tr>
818
776
  <td style="padding:15px">postTopologyV2TopologyIdTeContainersBulk(topologyId, body, callback)</td>
819
- <td style="padding:15px">Create a list of TE Container</td>
777
+ <td style="padding:15px">Create a list of te-containers</td>
820
778
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-containers/bulk?{query}</td>
821
779
  <td style="padding:15px">Yes</td>
822
780
  </tr>
823
781
  <tr>
824
782
  <td style="padding:15px">putTopologyV2TopologyIdTeContainersBulk(topologyId, body, callback)</td>
825
- <td style="padding:15px">Modify a list of TE Container</td>
783
+ <td style="padding:15px">Update a list of te-containers</td>
826
784
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-containers/bulk?{query}</td>
827
785
  <td style="padding:15px">Yes</td>
828
786
  </tr>
829
787
  <tr>
830
788
  <td style="padding:15px">patchTopologyV2TopologyIdTeContainersBulk(topologyId, body, callback)</td>
831
- <td style="padding:15px">Modify a list of TE
832
- Container using a PATCH</td>
789
+ <td style="padding:15px">Update a list of te-containers</td>
833
790
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-containers/bulk?{query}</td>
834
791
  <td style="padding:15px">Yes</td>
835
792
  </tr>
836
793
  <tr>
837
794
  <td style="padding:15px">deleteTopologyV2TopologyIdTeContainersBulk(topologyId, callback)</td>
838
- <td style="padding:15px">Deletes a list of containers.</td>
795
+ <td style="padding:15px">Delete a list of te-containers</td>
839
796
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/te-containers/bulk?{query}</td>
840
797
  <td style="padding:15px">Yes</td>
841
798
  </tr>
842
799
  <tr>
843
800
  <td style="padding:15px">getTopologyV2TopologyIdRoutes(topologyId, callback)</td>
844
- <td style="padding:15px">List all nodes with BGP routes and the number of routes for that node.</td>
801
+ <td style="padding:15px">Provide a summary of discovered BGP routes</td>
845
802
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/routes?{query}</td>
846
803
  <td style="padding:15px">Yes</td>
847
804
  </tr>
848
805
  <tr>
849
806
  <td style="padding:15px">getTopologyV2TopologyIdRoutesNodeIndex(topologyId, nodeIndex, callback)</td>
850
- <td style="padding:15px">Gets the routes maintained by Paragon PathFinder for a node.</td>
807
+ <td style="padding:15px">List the IP routes on a given node</td>
851
808
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/routes/{pathv2}?{query}</td>
852
809
  <td style="padding:15px">Yes</td>
853
810
  </tr>
854
811
  <tr>
855
812
  <td style="padding:15px">postTopologyV2TopologyIdPathComputation(topologyId, body, callback)</td>
856
- <td style="padding:15px">Use the following schema to request for a path computation:
857
-
858
- </td>
813
+ <td style="padding:15px">Compute a set of path</td>
859
814
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/pathComputation?{query}</td>
860
815
  <td style="padding:15px">Yes</td>
861
816
  </tr>
862
817
  <tr>
863
818
  <td style="padding:15px">postTopologyV2RpcOptimize(body, callback)</td>
864
- <td style="padding:15px">Trigger global or targeted path optimization.</td>
819
+ <td style="padding:15px">Trigger global or targeted optimization</td>
865
820
  <td style="padding:15px">{base_path}/{version}/topology/v2/rpc/optimize?{query}</td>
866
821
  <td style="padding:15px">Yes</td>
867
822
  </tr>
868
823
  <tr>
869
824
  <td style="padding:15px">getTopologyV2RpcOptimize(callback)</td>
870
- <td style="padding:15px">Get last global path optimization results.</td>
825
+ <td style="padding:15px">Get global optimization status</td>
871
826
  <td style="padding:15px">{base_path}/{version}/topology/v2/rpc/optimize?{query}</td>
872
827
  <td style="padding:15px">Yes</td>
873
828
  </tr>
874
829
  <tr>
875
830
  <td style="padding:15px">postTopologyV2RpcSimulation(body, callback)</td>
876
- <td style="padding:15px">Perform failure simulation analysis.</td>
831
+ <td style="padding:15px">Failure Simulation optimization RPC</td>
877
832
  <td style="padding:15px">{base_path}/{version}/topology/v2/rpc/simulation?{query}</td>
878
833
  <td style="padding:15px">Yes</td>
879
834
  </tr>
880
835
  <tr>
881
836
  <td style="padding:15px">getTopologyV2RpcSimulation(callback)</td>
882
- <td style="padding:15px">Returns the simulation list.</td>
837
+ <td style="padding:15px">Get Simulation optimization RPC list</td>
883
838
  <td style="padding:15px">{base_path}/{version}/topology/v2/rpc/simulation?{query}</td>
884
839
  <td style="padding:15px">Yes</td>
885
840
  </tr>
886
841
  <tr>
887
842
  <td style="padding:15px">getTopologyV2RpcSimulationUuid(uuid, callback)</td>
888
- <td style="padding:15px">Returns the details of a specified simulation.</td>
843
+ <td style="padding:15px">Get a specific simulation</td>
889
844
  <td style="padding:15px">{base_path}/{version}/topology/v2/rpc/simulation/{pathv1}?{query}</td>
890
845
  <td style="padding:15px">Yes</td>
891
846
  </tr>
892
847
  <tr>
893
848
  <td style="padding:15px">getTopologyV2RpcSimulationUuidReportName(uuid, reportName, callback)</td>
894
- <td style="padding:15px">Returns specific report details of a selected simulation.</td>
849
+ <td style="padding:15px">Get a specific report of one simulation</td>
895
850
  <td style="padding:15px">{base_path}/{version}/topology/v2/rpc/simulation/{pathv1}/{pathv2}?{query}</td>
896
851
  <td style="padding:15px">Yes</td>
897
852
  </tr>
898
853
  <tr>
899
854
  <td style="padding:15px">postTopologyV2RpcDiverseTreeDesign(body, callback)</td>
900
- <td style="padding:15px">Create 2 P2MP trees and perform Diverse P2MP Tree Design.</td>
855
+ <td style="padding:15px">P2MP Diverse Tree Design optimization RPC</td>
901
856
  <td style="padding:15px">{base_path}/{version}/topology/v2/rpc/diverseTreeDesign?{query}</td>
902
857
  <td style="padding:15px">Yes</td>
903
858
  </tr>
904
859
  <tr>
905
860
  <td style="padding:15px">getTopologyV2RpcDiverseTreeDesign(callback)</td>
906
- <td style="padding:15px">Return the list of simulation optimization RPC list.</td>
861
+ <td style="padding:15px">Get Simulation optimization RPC list</td>
907
862
  <td style="padding:15px">{base_path}/{version}/topology/v2/rpc/diverseTreeDesign?{query}</td>
908
863
  <td style="padding:15px">Yes</td>
909
864
  </tr>
910
865
  <tr>
911
866
  <td style="padding:15px">getTopologyV2RpcDiverseTreeDesignUuid(uuid, callback)</td>
912
- <td style="padding:15px">Return the details of specified simulation optimization RPC result.</td>
867
+ <td style="padding:15px">Get a Specific Simulation optimization RPC Result</td>
913
868
  <td style="padding:15px">{base_path}/{version}/topology/v2/rpc/diverseTreeDesign/{pathv1}?{query}</td>
914
869
  <td style="padding:15px">Yes</td>
915
870
  </tr>
916
871
  <tr>
917
872
  <td style="padding:15px">getSchedulerV2Tasklist(callback)</td>
918
- <td style="padding:15px">Returns a full list of Tasks as per JSON schema:
919
- </td>
873
+ <td style="padding:15px">Gets all Tasks</td>
920
874
  <td style="padding:15px">{base_path}/{version}/scheduler/v2/tasklist?{query}</td>
921
875
  <td style="padding:15px">Yes</td>
922
876
  </tr>
923
877
  <tr>
924
878
  <td style="padding:15px">getSchedulerV2Tasks(callback)</td>
925
- <td style="padding:15px">Returns a list of Tasks by filter tasktype(?tasktype={tasktypeFilter}) as per JSON schema:
926
- </td>
879
+ <td style="padding:15px">Get tasks based on filter tasktype</td>
927
880
  <td style="padding:15px">{base_path}/{version}/scheduler/v2/tasks?{query}</td>
928
881
  <td style="padding:15px">Yes</td>
929
882
  </tr>
930
883
  <tr>
931
884
  <td style="padding:15px">postSchedulerV2Addtask(body, callback)</td>
932
- <td style="padding:15px">Create a task using the following JSON schema:
933
- </td>
885
+ <td style="padding:15px">Create a task</td>
934
886
  <td style="padding:15px">{base_path}/{version}/scheduler/v2/addtask?{query}</td>
935
887
  <td style="padding:15px">Yes</td>
936
888
  </tr>
937
889
  <tr>
938
890
  <td style="padding:15px">postSchedulerV2Updatetask(body, callback)</td>
939
- <td style="padding:15px">Update a task using the following JSON schema:
940
- </td>
891
+ <td style="padding:15px">Update a task</td>
941
892
  <td style="padding:15px">{base_path}/{version}/scheduler/v2/updatetask?{query}</td>
942
893
  <td style="padding:15px">Yes</td>
943
894
  </tr>
944
895
  <tr>
945
896
  <td style="padding:15px">postSchedulerV2Removeaddtask(body, callback)</td>
946
- <td style="padding:15px">Removes all the existing tasks with given taskType and adds a new Task using the following JSON schema:
947
- </td>
897
+ <td style="padding:15px">Remove and add a new Task</td>
948
898
  <td style="padding:15px">{base_path}/{version}/scheduler/v2/removeaddtask?{query}</td>
949
899
  <td style="padding:15px">Yes</td>
950
900
  </tr>
951
901
  <tr>
952
902
  <td style="padding:15px">postSchedulerV2Deletetask(body, callback)</td>
953
- <td style="padding:15px">Delete one or more tasks using the following JSON schema:
954
- </td>
903
+ <td style="padding:15px">Delete tasks</td>
955
904
  <td style="padding:15px">{base_path}/{version}/scheduler/v2/deletetask?{query}</td>
956
905
  <td style="padding:15px">Yes</td>
957
906
  </tr>
958
907
  <tr>
959
908
  <td style="padding:15px">getSchedulerV2TaskshistoryTaskId(taskId, callback)</td>
960
- <td style="padding:15px">Returns task execution status history in HTML table format as per JSON schema:
961
- </td>
909
+ <td style="padding:15px">Gets task execution status history in HTML table format for a given taskId</td>
962
910
  <td style="padding:15px">{base_path}/{version}/scheduler/v2/taskshistory/{pathv1}?{query}</td>
963
911
  <td style="padding:15px">Yes</td>
964
912
  </tr>
965
913
  <tr>
966
914
  <td style="padding:15px">getSchedulerV2TaskstatusTaskId(taskId, callback)</td>
967
- <td style="padding:15px">Returns task execution status history as per JSON schema:
968
- </td>
915
+ <td style="padding:15px">Gets task execution status history for a given taskId</td>
969
916
  <td style="padding:15px">{base_path}/{version}/scheduler/v2/taskstatus/{pathv1}?{query}</td>
970
917
  <td style="padding:15px">Yes</td>
971
918
  </tr>
972
919
  <tr>
973
920
  <td style="padding:15px">postConfig(body, callback)</td>
974
- <td style="padding:15px">Updates all component configurations using the following JSON schema:
975
- </td>
921
+ <td style="padding:15px">Updates all component configurations</td>
976
922
  <td style="padding:15px">{base_path}/{version}/config?{query}</td>
977
923
  <td style="padding:15px">Yes</td>
978
924
  </tr>
979
925
  <tr>
980
926
  <td style="padding:15px">patchConfig(body, callback)</td>
981
- <td style="padding:15px">Updates configuration similar to plain-patch mechanism described in RFC7396. The content of the request body will be merged into Paragon PathFinder configuration. The limitation of this method is that it is not supporting deletion of attributes, for that the DELETE method should be used.
982
- Two known deviations from RFC are: arrays types are merged instead of getting replaced and to unset the empty types DELETE operation has to be used.
983
- </td>
927
+ <td style="padding:15px">Patch some component configurations</td>
984
928
  <td style="padding:15px">{base_path}/{version}/config?{query}</td>
985
929
  <td style="padding:15px">Yes</td>
986
930
  </tr>
987
931
  <tr>
988
932
  <td style="padding:15px">deleteConfig(callback)</td>
989
- <td style="padding:15px">Delete component configurations using the following JSON schema:
990
- </td>
933
+ <td style="padding:15px">DELETE configuration</td>
991
934
  <td style="padding:15px">{base_path}/{version}/config?{query}</td>
992
935
  <td style="padding:15px">Yes</td>
993
936
  </tr>
994
937
  <tr>
995
938
  <td style="padding:15px">getTransportControllersV2(callback)</td>
996
- <td style="padding:15px">Returns a full list of the transport controllers using the following schema:
997
- </td>
939
+ <td style="padding:15px">Get Transport Controller List</td>
998
940
  <td style="padding:15px">{base_path}/{version}/transportControllers/v2?{query}</td>
999
941
  <td style="padding:15px">Yes</td>
1000
942
  </tr>
1001
943
  <tr>
1002
944
  <td style="padding:15px">postTransportControllersV2(body, callback)</td>
1003
- <td style="padding:15px">Creates a transport controller using the following schema:
1004
- </td>
945
+ <td style="padding:15px">Create Transport Controller Configuration</td>
1005
946
  <td style="padding:15px">{base_path}/{version}/transportControllers/v2?{query}</td>
1006
947
  <td style="padding:15px">Yes</td>
1007
948
  </tr>
1008
949
  <tr>
1009
950
  <td style="padding:15px">getTransportControllersV2TransportControllerIndex(transportControllerIndex, callback)</td>
1010
- <td style="padding:15px">Returns the configuration of a transport controller.</td>
951
+ <td style="padding:15px">Get Transport Controller Configuration</td>
1011
952
  <td style="padding:15px">{base_path}/{version}/transportControllers/v2/{pathv1}?{query}</td>
1012
953
  <td style="padding:15px">Yes</td>
1013
954
  </tr>
1014
955
  <tr>
1015
956
  <td style="padding:15px">putTransportControllersV2TransportControllerIndex(transportControllerIndex, body, callback)</td>
1016
- <td style="padding:15px">Updates a transport controller using the following schema:
1017
- </td>
957
+ <td style="padding:15px">Update Transport Controller Configuration</td>
1018
958
  <td style="padding:15px">{base_path}/{version}/transportControllers/v2/{pathv1}?{query}</td>
1019
959
  <td style="padding:15px">Yes</td>
1020
960
  </tr>
1021
961
  <tr>
1022
962
  <td style="padding:15px">deleteTransportControllersV2TransportControllerIndex(transportControllerIndex, callback)</td>
1023
- <td style="padding:15px">Deletes a transport controller configuration. The transport node, link, and circuits created from that transport controller are not deleted. You must delete them manually, if required.</td>
963
+ <td style="padding:15px">Delete Transport Controller Configuration</td>
1024
964
  <td style="padding:15px">{base_path}/{version}/transportControllers/v2/{pathv1}?{query}</td>
1025
965
  <td style="padding:15px">Yes</td>
1026
966
  </tr>
1027
967
  <tr>
1028
968
  <td style="padding:15px">getTransportControllerGroupsV2(callback)</td>
1029
- <td style="padding:15px">Returns the full list of transport controller groups using the following schema:
1030
- </td>
969
+ <td style="padding:15px">Get Transport Controller Device Groups</td>
1031
970
  <td style="padding:15px">{base_path}/{version}/transportControllerGroups/v2?{query}</td>
1032
971
  <td style="padding:15px">Yes</td>
1033
972
  </tr>
1034
973
  <tr>
1035
974
  <td style="padding:15px">postTransportControllerGroupsV2(body, callback)</td>
1036
- <td style="padding:15px">Creates a group of transport controller devices using the following schema:
1037
- </td>
975
+ <td style="padding:15px">Create A Transport Controller Device Group</td>
1038
976
  <td style="padding:15px">{base_path}/{version}/transportControllerGroups/v2?{query}</td>
1039
977
  <td style="padding:15px">Yes</td>
1040
978
  </tr>
1041
979
  <tr>
1042
980
  <td style="padding:15px">deleteTransportControllerGroupsV2(callback)</td>
1043
- <td style="padding:15px">Deletes a group of transport controller devices using the following schema:
1044
- </td>
981
+ <td style="padding:15px">Delete a Transport Controller Device Group</td>
1045
982
  <td style="padding:15px">{base_path}/{version}/transportControllerGroups/v2?{query}</td>
1046
983
  <td style="padding:15px">Yes</td>
1047
984
  </tr>
1048
985
  <tr>
1049
986
  <td style="padding:15px">getTransportControllerGroupsV2TransportControllerGroupName(transportControllerGroupName, callback)</td>
1050
- <td style="padding:15px">Returns a list of transport controller groups using the following schema:
1051
- </td>
987
+ <td style="padding:15px">Get Transport Controller Device Groups</td>
1052
988
  <td style="padding:15px">{base_path}/{version}/transportControllerGroups/v2/{pathv1}?{query}</td>
1053
989
  <td style="padding:15px">Yes</td>
1054
990
  </tr>
1055
991
  <tr>
1056
992
  <td style="padding:15px">putTransportControllerGroupsV2TransportControllerGroupName(transportControllerGroupName, body, callback)</td>
1057
- <td style="padding:15px">Updates devices in a group using the following schema:
1058
- </td>
993
+ <td style="padding:15px">Update Devices in the Group</td>
1059
994
  <td style="padding:15px">{base_path}/{version}/transportControllerGroups/v2/{pathv1}?{query}</td>
1060
995
  <td style="padding:15px">Yes</td>
1061
996
  </tr>
1062
997
  <tr>
1063
998
  <td style="padding:15px">postTransportControllerGroupsV2TransportControllerGroupName(transportControllerGroupName, body, callback)</td>
1064
- <td style="padding:15px">Creates devices in a group using the following schema:
1065
- </td>
999
+ <td style="padding:15px">Create New Devices in a Group</td>
1066
1000
  <td style="padding:15px">{base_path}/{version}/transportControllerGroups/v2/{pathv1}?{query}</td>
1067
1001
  <td style="padding:15px">Yes</td>
1068
1002
  </tr>
1069
1003
  <tr>
1070
1004
  <td style="padding:15px">deleteTransportControllerGroupsV2TransportControllerGroupName(transportControllerGroupName, callback)</td>
1071
- <td style="padding:15px">Deletes devices from a group using the following schema:
1072
- </td>
1005
+ <td style="padding:15px">Delete Devices in the Group</td>
1073
1006
  <td style="padding:15px">{base_path}/{version}/transportControllerGroups/v2/{pathv1}?{query}</td>
1074
1007
  <td style="padding:15px">Yes</td>
1075
1008
  </tr>
1076
1009
  <tr>
1077
1010
  <td style="padding:15px">getNetconfV2Profiles(callback)</td>
1078
- <td style="padding:15px">Gets all profiles.</td>
1011
+ <td style="padding:15px">Get all Profiles</td>
1079
1012
  <td style="padding:15px">{base_path}/{version}/netconf/v2/profiles?{query}</td>
1080
1013
  <td style="padding:15px">Yes</td>
1081
1014
  </tr>
1082
1015
  <tr>
1083
1016
  <td style="padding:15px">postNetconfV2Profiles(body, callback)</td>
1084
- <td style="padding:15px">Creates new profiles.</td>
1017
+ <td style="padding:15px">Create New Profiles</td>
1085
1018
  <td style="padding:15px">{base_path}/{version}/netconf/v2/profiles?{query}</td>
1086
1019
  <td style="padding:15px">Yes</td>
1087
1020
  </tr>
1088
1021
  <tr>
1089
1022
  <td style="padding:15px">putNetconfV2Profiles(body, callback)</td>
1090
- <td style="padding:15px">Updates profiles.</td>
1023
+ <td style="padding:15px">Update Profiles</td>
1091
1024
  <td style="padding:15px">{base_path}/{version}/netconf/v2/profiles?{query}</td>
1092
1025
  <td style="padding:15px">Yes</td>
1093
1026
  </tr>
1094
1027
  <tr>
1095
1028
  <td style="padding:15px">deleteNetconfV2Profiles(callback)</td>
1096
- <td style="padding:15px">Deletes profiles.</td>
1029
+ <td style="padding:15px">Delete Profiles</td>
1097
1030
  <td style="padding:15px">{base_path}/{version}/netconf/v2/profiles?{query}</td>
1098
1031
  <td style="padding:15px">Yes</td>
1099
1032
  </tr>
1100
1033
  <tr>
1101
1034
  <td style="padding:15px">postNetconfV2CollectionLiveNetwork(body, callback)</td>
1102
- <td style="padding:15px">Creates a new collection.</td>
1035
+ <td style="padding:15px">Create a New Collect</td>
1103
1036
  <td style="padding:15px">{base_path}/{version}/netconf/v2/collection/liveNetwork?{query}</td>
1104
1037
  <td style="padding:15px">Yes</td>
1105
1038
  </tr>
1106
1039
  <tr>
1107
1040
  <td style="padding:15px">getNetconfV2CollectionCollectionJobId(collectionJobId, callback)</td>
1108
- <td style="padding:15px">Gets the Status of a collection job.</td>
1041
+ <td style="padding:15px">Get the Status of a Collection Job</td>
1109
1042
  <td style="padding:15px">{base_path}/{version}/netconf/v2/collection/{pathv1}?{query}</td>
1110
1043
  <td style="padding:15px">Yes</td>
1111
1044
  </tr>
1112
1045
  <tr>
1113
1046
  <td style="padding:15px">getComponentConfig(callback)</td>
1114
- <td style="padding:15px">Return a json object containing component configurations
1115
- </td>
1047
+ <td style="padding:15px">Get Paragon PathFinder component configurations</td>
1116
1048
  <td style="padding:15px">{base_path}/{version}/config?{query}</td>
1117
1049
  <td style="padding:15px">Yes</td>
1118
1050
  </tr>
1119
1051
  <tr>
1120
1052
  <td style="padding:15px">getTopologyV2TopologyIdIpePolicy(topologyId, callback)</td>
1121
- <td style="padding:15px">Get all IPE Policies</td>
1053
+ <td style="padding:15px">Get all IPE Policie</td>
1122
1054
  <td style="padding:15px">{base_path}/{version}/topology/v2/{pathv1}/ipe/policy?{query}</td>
1123
1055
  <td style="padding:15px">Yes</td>
1124
1056
  </tr>