@itentialopensource/adapter-netbox_v210 0.2.1 → 0.3.0

package/entities/.generic/action.json

@@ -104,6 +104,111 @@
           "mockFile": ""
         }
       ]
+    },
+    {
+      "name": "getGenericsNoBase",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "createGenericNoBase",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "updateGenericNoBase",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "patchGenericNoBase",
+      "protocol": "REST",
+      "method": "PATCH",
+      "entitypath": "/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "deleteGenericNoBase",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
     }
   ]
 }

package/entities/.generic/schema.json

@@ -14,7 +14,12 @@
         "createGeneric",
         "updateGeneric",
         "patchGeneric",
-        "deleteGeneric"
+        "deleteGeneric",
+        "getGenericsNoBase",
+        "createGenericNoBase",
+        "updateGenericNoBase",
+        "patchGenericNoBase",
+        "deleteGenericNoBase"
       ],
       "external_name": "ph_request_type"
     }

package/error.json

@@ -96,6 +96,12 @@
       "displayString": "Invalid properties: $VARIABLE$",
       "recommendation": "Verify the properties for the adapter"
     },
+    {
+      "key": "Missing Properties",
+      "icode": "AD.306",
+      "displayString": "Property $VARIABLE$ is required",
+      "recommendation": "Please provide the required property"
+    },
     {
       "key": "Query Not Translated",
       "icode": "AD.310",

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@itentialopensource/adapter-netbox_v210",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "This adapter integrates with system described as: Netbox v2.10",
   "main": "adapter.js",
+  "systemName": "NetBox v2.10",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.59.55",
+  "engineVersion": "1.61.6",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -53,11 +54,12 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/inventory/adapter-netbox_v210#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^4.44.11",
+    "@itentialopensource/adapter-utils": "^4.45.6",
     "ajv": "^6.12.0",
     "axios": "^0.21.0",
     "commander": "^2.20.0",
     "fs-extra": "^8.1.0",
+    "json-query": "^2.2.2",
     "mocha": "^9.0.1",
     "mocha-param": "^2.0.1",
     "mongodb": "^4.1.0",

package/pronghorn.json

@@ -9,7 +9,7 @@
   ],
   "methods": [
     {
-      "name": "updateAdapterConfiguration",
+      "name": "iapUpdateAdapterConfiguration",
       "summary": "Updates the adapter configuration",
       "description": "Updates the adapter configuration file with the provided changes",
       "input": [
@@ -78,12 +78,12 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/updateAdapterConfiguration"
+        "path": "/iapUpdateAdapterConfiguration"
       },
       "task": true
     },
     {
-      "name": "findPath",
+      "name": "iapFindAdapterPath",
       "summary": "Provides the ability to see if a particular API path is supported by the adapter",
       "description": "Provides the ability to see if a particular API path is supported by the adapter",
       "input": [
@@ -113,36 +113,35 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/findPath"
+        "path": "/iapFindAdapterPath"
       },
       "task": true
     },
     {
-      "name": "troubleshoot",
-      "summary": "Runs troubleshoot script for adapter",
-      "description": "Runs troubleshoot script for adapter",
+      "name": "iapSuspendAdapter",
+      "summary": "Suspends the adapter",
+      "description": "Suspends the adapter",
       "input": [
         {
-          "name": "props",
-          "type": "object",
-          "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
-          "required": true,
+          "name": "mode",
+          "type": "enum",
+          "enumerals": [
+            "pause",
+            "error"
+          ],
+          "info": "How incoming requests are handled. Defaults to 'pause'",
+          "description": "How incoming requests are handled. Defaults to 'pause'",
           "schema": {
-            "title": "props",
-            "type": "object"
-          }
-        },
-        {
-          "name": "persistFlag",
-          "type": "boolean",
-          "info": "Whether the input properties should be saved",
-          "required": true
+            "title": "mode",
+            "type": "string"
+          },
+          "required": false
         }
       ],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing the test results",
+        "description": "A JSON Object containing the adapter suspended status",
         "schema": {
           "title": "result",
           "type": "object"
@@ -153,38 +152,42 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/troubleshoot"
+        "path": "/iapSuspendAdapter"
       },
       "task": true
     },
     {
-      "name": "runHealthcheck",
-      "summary": "Runs healthcheck script for adapter",
-      "description": "Runs healthcheck script for adapter",
+      "name": "iapUnsuspendAdapter",
+      "summary": "Unsuspends the adapter",
+      "description": "Unsuspends the adapter",
       "input": [],
       "output": {
         "name": "result",
-        "type": "boolean",
-        "description": "Whether healthcheck passed or failed"
+        "type": "object",
+        "description": "A JSON Object containing the adapter suspended status",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
       },
       "roles": [
         "admin"
       ],
       "route": {
         "verb": "POST",
-        "path": "/runHealthcheck"
+        "path": "/iapUnsuspendAdapter"
       },
       "task": true
     },
     {
-      "name": "runConnectivity",
-      "summary": "Runs connectivity check script for adapter",
-      "description": "Runs connectivity check script for adapter",
+      "name": "iapGetAdapterQueue",
+      "summary": "Return the requests that are waiting in the queue if throttling is enabled",
+      "description": "Return the requests that are waiting in the queue if throttling is enabled",
       "input": [],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing the test results",
+        "description": "A JSON Object containing the adapter queue",
         "schema": {
           "title": "result",
           "type": "object"
@@ -195,15 +198,32 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/runConnectivity"
+        "path": "/iapGetAdapterQueue"
       },
       "task": true
     },
     {
-      "name": "runBasicGet",
-      "summary": "Runs basicGet script for adapter",
-      "description": "Runs basicGet script for adapter",
-      "input": [],
+      "name": "iapTroubleshootAdapter",
+      "summary": "Runs troubleshoot script for adapter",
+      "description": "Runs troubleshoot script for adapter",
+      "input": [
+        {
+          "name": "props",
+          "type": "object",
+          "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
+          "required": true,
+          "schema": {
+            "title": "props",
+            "type": "object"
+          }
+        },
+        {
+          "name": "persistFlag",
+          "type": "boolean",
+          "info": "Whether the input properties should be saved",
+          "required": true
+        }
+      ],
       "output": {
         "name": "result",
         "type": "object",
@@ -218,35 +238,38 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/runBasicGet"
+        "path": "/iapTroubleshootAdapter"
       },
       "task": true
     },
     {
-      "name": "suspend",
-      "summary": "Suspends the adapter",
-      "description": "Suspends the adapter",
-      "input": [
-        {
-          "name": "mode",
-          "type": "enum",
-          "enumerals": [
-            "pause",
-            "error"
-          ],
-          "info": "How incoming requests are handled. Defaults to 'pause'",
-          "description": "How incoming requests are handled. Defaults to 'pause'",
-          "schema": {
-            "title": "mode",
-            "type": "string"
-          },
-          "required": false
-        }
+      "name": "iapRunAdapterHealthcheck",
+      "summary": "Runs healthcheck script for adapter",
+      "description": "Runs healthcheck script for adapter",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "boolean",
+        "description": "Whether healthcheck passed or failed"
+      },
+      "roles": [
+        "admin"
       ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapRunAdapterHealthcheck"
+      },
+      "task": true
+    },
+    {
+      "name": "iapRunAdapterConnectivity",
+      "summary": "Runs connectivity check script for adapter",
+      "description": "Runs connectivity check script for adapter",
+      "input": [],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing the adapter suspended status",
+        "description": "A JSON Object containing the test results",
         "schema": {
           "title": "result",
           "type": "object"
@@ -257,19 +280,19 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/suspend"
+        "path": "/iapRunAdapterConnectivity"
       },
       "task": true
     },
     {
-      "name": "unsuspend",
-      "summary": "Unsuspends the adapter",
-      "description": "Unsuspends the adapter",
+      "name": "iapRunAdapterBasicGet",
+      "summary": "Runs basicGet script for adapter",
+      "description": "Runs basicGet script for adapter",
       "input": [],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing the adapter suspended status",
+        "description": "A JSON Object containing the test results",
         "schema": {
           "title": "result",
           "type": "object"
@@ -280,21 +303,21 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/unsuspend"
+        "path": "/iapRunAdapterBasicGet"
       },
       "task": true
     },
     {
-      "name": "getQueue",
-      "summary": "Return the requests that are waiting in the queue if throttling is enabled",
-      "description": "Return the requests that are waiting in the queue if throttling is enabled",
+      "name": "iapMoveAdapterEntitiesToDB",
+      "summary": "Moves entities from an adapter into the IAP database",
+      "description": "Moves entities from an adapter into the IAP database",
       "input": [],
       "output": {
-        "name": "result",
+        "name": "res",
         "type": "object",
-        "description": "A JSON Object containing the adapter queue",
+        "description": "A JSON Object containing status, code and the response from the mongo transaction",
         "schema": {
-          "title": "result",
+          "title": "res",
           "type": "object"
         }
       },
@@ -303,7 +326,7 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/getQueue"
+        "path": "/iapMoveAdapterEntitiesToDB"
       },
       "task": true
     },
@@ -387,16 +410,72 @@
       "task": true
     },
     {
-      "name": "moveEntitiesToDB",
-      "summary": "Moves entities from an adapter into the IAP database",
-      "description": "Moves entities from an adapter into the IAP database",
-      "input": [],
+      "name": "genericAdapterRequestNoBasePath",
+      "summary": "Makes the requested generic call with no base path or version",
+      "description": "Makes the requested generic call with no base path or version",
+      "input": [
+        {
+          "name": "uriPath",
+          "type": "string",
+          "info": "the path of the api call - do not include the host, port, base path or version",
+          "description": "the path of the api call",
+          "schema": {
+            "title": "uriPath",
+            "type": "string"
+          },
+          "required": true
+        },
+        {
+          "name": "restMethod",
+          "type": "string",
+          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
+          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
+          "schema": {
+            "title": "restMethod",
+            "type": "string"
+          },
+          "required": true
+        },
+        {
+          "name": "queryData",
+          "type": "object",
+          "info": "the query parameters to be put on the url (optional)",
+          "description": "the query parameters to be put on the url (optional)",
+          "schema": {
+            "title": "queryData",
+            "type": "object"
+          },
+          "required": false
+        },
+        {
+          "name": "requestBody",
+          "type": "object",
+          "info": "the payload to be sent with the request (optional)",
+          "description": "the payload to be sent with the request (optional)",
+          "schema": {
+            "title": "requestBody",
+            "type": "object"
+          },
+          "required": false
+        },
+        {
+          "name": "addlHeaders",
+          "type": "object",
+          "info": "additional headers to be put on the call (optional)",
+          "description": "additional headers to be put on the call (optional)",
+          "schema": {
+            "title": "addlHeaders",
+            "type": "object"
+          },
+          "required": false
+        }
+      ],
       "output": {
-        "name": "res",
+        "name": "result",
         "type": "object",
-        "description": "A JSON Object containing status, code and the response from the mongo transaction",
+        "description": "A JSON Object containing status, code and the result",
         "schema": {
-          "title": "res",
+          "title": "result",
           "type": "object"
         }
       },
@@ -405,7 +484,7 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/moveEntitiesToDB"
+        "path": "/genericAdapterRequestNoBasePath"
       },
       "task": true
     },
@@ -556,7 +635,7 @@
       "task": false
     },
     {
-      "name": "getCount",
+      "name": "iapGetDeviceCount",
       "summary": "Gets a device count from the system",
       "description": "Gets a device count from the system",
       "input": [],
@@ -574,7 +653,7 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/getCount"
+        "path": "/iapGetDeviceCount"
       },
       "task": false
     },

package/propertiesDecorators.json

@@ -0,0 +1,14 @@
+[
+  {
+    "type": "encryption",
+    "pointer": "/authentication/password"
+  },
+  {
+    "type": "encryption",
+    "pointer": "/authentication/token"
+  },
+  {
+    "type": "encryption",
+    "pointer": "/mongo/password"
+  }
+]