@itentialopensource/adapter-nokia_nsp_device_configurator 0.2.3 → 0.3.1

package/adapter.js

@@ -2526,23 +2526,24 @@ class NokiaNspDeviceConfigurator extends AdapterBaseCl {
   }
 
   /**
-   * @function fieldquerytoretrieveasinglechildnodeunderthetargetresource
+   * @function fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource
    * @pronghornType method
-   * @name fieldquerytoretrieveasinglechildnodeunderthetargetresource
+   * @name fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource
    * @summary Field query to retrieve a single child node under the target resource
    *
-   * @param {string} neType - neType param
-   * @param {string} neVersion - neVersion param
+   * @param {string} fields - fields param
+   * @param {string} neId - neId (network device) param
+   * @param {string} port - port param
    * @param {getCallback} callback - a callback function to return the result
    * @return {object} results - An object containing the response of the action
    *
-   * @route {POST} /fieldquerytoretrieveasinglechildnodeunderthetargetresource
+   * @route {POST} /fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource
    * @roles admin
    * @task true
    */
   /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
-  fieldquerytoretrieveasinglechildnodeunderthetargetresource(neType, neVersion, callback) {
-    const meth = 'adapter-fieldquerytoretrieveasinglechildnodeunderthetargetresource';
+  fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource(fields, neId, port, callback) {
+    const meth = 'adapter-fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
@@ -2553,21 +2554,26 @@ class NokiaNspDeviceConfigurator extends AdapterBaseCl {
     }
 
     /* HERE IS WHERE YOU VALIDATE DATA */
-    if (neType === undefined || neType === null || neType === '') {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['neType'], null, null, null);
+    if (fields === undefined || fields === null || fields === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['fields'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+    if (neId === undefined || neId === null || neId === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['neId'], null, null, null);
       log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
       return callback(null, errorObj);
     }
-    if (neVersion === undefined || neVersion === null || neVersion === '') {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['neVersion'], null, null, null);
+    if (port === undefined || port === null || port === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['port'], null, null, null);
       log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
       return callback(null, errorObj);
     }
 
     /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
-    const queryParamsAvailable = {};
+    const queryParamsAvailable = { fields };
     const queryParams = {};
-    const pathVars = [`neType=${neType}`, `neVersion=${neVersion}`];
+    const pathVars = [`network-device=${neId}`, `port=${port}`];
     const bodyVars = {};
 
     // loop in template. long callback arg name to avoid identifier conflicts
@@ -2606,7 +2612,7 @@ class NokiaNspDeviceConfigurator extends AdapterBaseCl {
     try {
       // Make the call -
       // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
-      return this.requestHandlerInst.identifyRequest('Search', 'fieldquerytoretrieveasinglechildnodeunderthetargetresource', reqObj, true, (irReturnData, irReturnError) => {
+      return this.requestHandlerInst.identifyRequest('Search', 'fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource', reqObj, true, (irReturnData, irReturnError) => {
         // if we received an error or their is no response on the results
         // return an error
         if (irReturnError) {
@@ -2614,7 +2620,7 @@ class NokiaNspDeviceConfigurator extends AdapterBaseCl {
           return callback(null, irReturnError);
         }
         if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
-          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['fieldquerytoretrieveasinglechildnodeunderthetargetresource'], null, null, null);
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource'], null, null, null);
           log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
           return callback(null, errorObj);
         }

package/entities/Search/action.json

@@ -43,10 +43,10 @@
       ]
     },
     {
-      "name": "fieldquerytoretrieveasinglechildnodeunderthetargetresource",
+      "name": "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource",
       "protocol": "REST",
       "method": "GET",
-      "entitypath": "{base_path}/{version}/restconf/meta/api/v1/model/schema/{pathv1}/{pathv2}/nokia-conf:/configure/filter?{query}",
+      "entitypath": "{base_path}/{version}/restconf/data/network-device-mgr:network-devices/{pathv1}/root/nokia-conf:/configure/{pathv2}?{query}",
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,

package/entities/Search/schema.json

@@ -12,7 +12,7 @@
       "enum": [
         "fieldquerytoselectmultiplefieldsunderthetargetresource",
         "fieldquerywithsubSelectorsofanodeunderthetargetresource",
-        "fieldquerytoretrieveasinglechildnodeunderthetargetresource"
+        "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource"
       ],
       "external_name": "ph_request_type"
     }

package/metadata.json

@@ -35,20 +35,47 @@
     "isDeprecated": false
   },
   "brokerSince": "",
+  "authMethods": [
+    {
+      "type": "OAuth",
+      "subtypes": [],
+      "primary": true
+    }
+  ],
   "documentation": {
     "storeLink": "",
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-nokia_nsp_device_configurator",
-    "repoLink": "https://gitlab.com/itentialopensource/adapters/sd-wan/adapter-nokia_nsp_device_configurator",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/adapter-nokia_nsp_device_configurator",
     "docLink": "",
-    "demoLinks": [],
-    "trainingLinks": [],
+    "demoLinks": [
+      {
+        "title": "Itential SD-WAN Network Automation Solution",
+        "link": "https://www.itential.com/industries/communications-service-providers/sdwan-network-automation/"
+      },
+      {
+        "title": "Multi-Vendor SD-WAN",
+        "link": "https://www.itential.com/solutions/sdwan-automation-orchestration/"
+      }
+    ],
+    "trainingLinks": [
+      {
+        "title": "Itential Academy",
+        "link": "https://www.itential.com/itential-academy/"
+      }
+    ],
     "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
     "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
     "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
-    "webLink": "",
-    "vendorLink": "",
-    "productLink": "",
-    "apiLinks": []
+    "webLink": "https://www.itential.com/adapters/nokia-nsp-device-configurator/",
+    "vendorLink": "https://www.nokia.com/",
+    "productLink": "https://www.nokia.com/networks/ip-networks/network-services-platform/",
+    "apiLinks": [
+      {
+        "title": "Nokia NSP API",
+        "link": "https://documentation.nokia.com/cgi-bin/dbaccessfilename.cgi/3HE12075AAAATQZZA01_V1_NSP%2017.3%20API%20Programmer%20Guide.pdf",
+        "public": true
+      }
+    ]
   },
   "assets": [],
   "relatedItems": {

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@itentialopensource/adapter-nokia_nsp_device_configurator",
-  "version": "0.2.3",
+  "version": "0.3.1",
   "description": "This adapter integrates with system described as: 22.11Modeled-deviceConfiguratorRestconfApis.",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.14",
+  "engineVersion": "1.67.19",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -15,7 +15,6 @@
     "test:baseunit": "mocha test/unit/adapterBaseTestUnit.js --LOG=error",
     "test:unit": "mocha test/unit/adapterTestUnit.js --LOG=error",
     "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
-    "test:cover": "nyc --reporter html --reporter text mocha --reporter dot test/*",
     "test": "npm run test:baseunit && npm run test:unit && npm run test:integration",
     "adapter:install": "npm i && node utils/tbScript.js install",
     "adapter:checkMigrate": "node utils/checkMigrate.js",
@@ -43,15 +42,15 @@
   ],
   "license": "Apache-2.0",
   "engines": {
-    "node": ">= 8.0.0",
+    "node": ">= 14.0.0",
     "npm": ">= 6.0.0"
   },
   "repository": {
     "type": "git",
-    "url": "git@gitlab.com:itentialopensource/adapters/sd-wan/adapter-nokia_nsp_device_configurator.git"
+    "url": "git@gitlab.com:itentialopensource/adapters/adapter-nokia_nsp_device_configurator.git"
   },
   "author": "Itential",
-  "homepage": "https://gitlab.com/itentialopensource/adapters/sd-wan/adapter-nokia_nsp_device_configurator#readme",
+  "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-nokia_nsp_device_configurator#readme",
   "dependencies": {
     "@itentialopensource/adapter-utils": "^5.3.10",
     "acorn": "^8.10.0",
@@ -64,7 +63,6 @@
     "mocha": "^10.3.0",
     "mocha-param": "^2.0.1",
     "mongodb": "^4.16.0",
-    "nyc": "^15.1.0",
     "ping": "^0.4.4",
     "prompts": "^2.4.2",
     "readline-sync": "^1.4.10",

package/pronghorn.json

@@ -4023,27 +4023,37 @@
       "task": true
     },
     {
-      "name": "fieldquerytoretrieveasinglechildnodeunderthetargetresource",
+      "name": "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource",
       "summary": "Field query to retrieve a single child node under the target resource",
       "description": "Field query to retrieve a single child node under the target resource",
       "input": [
         {
-          "name": "neType",
+          "name": "fields",
+          "type": "string",
+          "info": ": string",
+          "required": true,
+          "schema": {
+            "title": "fields",
+            "type": "string"
+          }
+        },
+        {
+          "name": "neId",
           "type": "string",
           "info": ": string",
           "required": true,
           "schema": {
-            "title": "neType",
+            "title": "neId",
             "type": "string"
           }
         },
         {
-          "name": "neVersion",
+          "name": "port",
           "type": "string",
           "info": ": string",
           "required": true,
           "schema": {
-            "title": "neVersion",
+            "title": "port",
             "type": "string"
           }
         }
@@ -4055,7 +4065,7 @@
         "schema": {
           "allOf": [
             {
-              "title": "Fieldquerytoretrieveasinglechildnodeunderthetargetresource",
+              "title": "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource",
               "required": [
                 "nokia-conf:port"
               ],
@@ -4254,7 +4264,7 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/fieldquerytoretrieveasinglechildnodeunderthetargetresource"
+        "path": "/fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource"
       },
       "task": true
     },

package/propertiesSchema.json

@@ -945,6 +945,11 @@
     "devicebroker": {
       "type": "object",
       "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether or not the device broker calls have been mapped",
+          "default": false
+        },
         "getDevice": {
           "type": "array",
           "description": "Broker call(s) to getDevice",

package/report/22.11Modeled-DeviceConfiguratorRestCONFAPIs.postman_collection.json-OpenApi3Json.json

@@ -3792,7 +3792,7 @@
         ],
         "summary": "Field query to retrieve a single child node under the target resource",
         "description": "Field query to retrieve a single child node under the target resource",
-        "operationId": "Fieldquerytoretrieveasinglechildnodeunderthetargetresource",
+        "operationId": "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource",
         "parameters": [
           {
             "name": "Content-Type",
@@ -3962,7 +3962,7 @@
                 "schema": {
                   "allOf": [
                     {
-                      "$ref": "#/components/schemas/Fieldquerytoretrieveasinglechildnodeunderthetargetresource"
+                      "$ref": "#/components/schemas/fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource"
                     },
                     {
                       "example": {
@@ -8368,8 +8368,8 @@
           "mda-type": "m60-10/100eth-tx"
         }
       },
-      "Fieldquerytoretrieveasinglechildnodeunderthetargetresource": {
-        "title": "Fieldquerytoretrieveasinglechildnodeunderthetargetresource",
+      "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource": {
+        "title": "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource",
         "required": [
           "nokia-conf:port"
         ],

package/report/adapter-openapi.json

@@ -3792,7 +3792,7 @@
         ],
         "summary": "Field query to retrieve a single child node under the target resource",
         "description": "Field query to retrieve a single child node under the target resource",
-        "operationId": "Fieldquerytoretrieveasinglechildnodeunderthetargetresource",
+        "operationId": "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource",
         "parameters": [
           {
             "name": "Content-Type",
@@ -3962,7 +3962,7 @@
                 "schema": {
                   "allOf": [
                     {
-                      "$ref": "#/components/schemas/Fieldquerytoretrieveasinglechildnodeunderthetargetresource"
+                      "$ref": "#/components/schemas/fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource"
                     },
                     {
                       "example": {
@@ -8368,8 +8368,8 @@
           "mda-type": "m60-10/100eth-tx"
         }
       },
-      "Fieldquerytoretrieveasinglechildnodeunderthetargetresource": {
-        "title": "Fieldquerytoretrieveasinglechildnodeunderthetargetresource",
+      "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource": {
+        "title": "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource",
         "required": [
           "nokia-conf:port"
         ],

package/report/adapter-openapi.yaml

@@ -2482,9 +2482,9 @@ paths:
     get:
       tags:
       - Search
-      summary: Fieldquerytoretrieveasinglechildnodeunderthetargetresource
+      summary: fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource
       description: Field query to retrieve a single child node under the target resource
-      operationId: Fieldquerytoretrieveasinglechildnodeunderthetargetresource
+      operationId: fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource
       parameters:
       - name: Content-Type
         in: header
@@ -2604,7 +2604,7 @@ paths:
             application/json;charset=UTF-8:
               schema:
                 allOf:
-                - $ref: '#/components/schemas/Fieldquerytoretrieveasinglechildnodeunderthetargetresource'
+                - $ref: '#/components/schemas/fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource'
                 - example:
                     nokia-conf:port:
                     - ethernet:
@@ -5788,8 +5788,8 @@ components:
       example:
         mda-slot: 1
         mda-type: m60-10/100eth-tx
-    Fieldquerytoretrieveasinglechildnodeunderthetargetresource:
-      title: Fieldquerytoretrieveasinglechildnodeunderthetargetresource
+    fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource:
+      title: fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource
       required:
       - nokia-conf:port
       type: object

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.1.5",
-  "configLines": 8373,
+  "version": "0.3.0",
+  "configLines": 8388,
   "scriptLines": 1783,
-  "codeLines": 4492,
-  "testLines": 4838,
-  "testCases": 231,
-  "totalCodeLines": 11113,
+  "codeLines": 4498,
+  "testLines": 4853,
+  "testCases": 232,
+  "totalCodeLines": 11134,
   "wfTasks": 48
 }

package/report/updateReport1715046488130.json

@@ -0,0 +1,120 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "New adapter errors available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors no longer available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors that have been updated (e.g. recommendation changes)",
+      "value": 31
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 16
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 21
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^5.3.10"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 78
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 344
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 647
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 48
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the ENHANCE.md",
+      "value": 70
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the BROKER.md",
+      "value": 70
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 2429
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 129
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 1156
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 32
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1453
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 36
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 5038
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 161
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}