@itentialopensource/adapter-dna_center 0.5.6 → 0.5.7

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,31 +78,63 @@
       ],
       "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": [
-        {
-          "name": "apiPath",
-          "type": "string",
-          "info": "The API Path you want to check - make sure to not include base path and version",
-          "description": "The API Path you want to check - make sure to not include base path and version",
-          "schema": {
-            "title": "apiPath",
-            "type": "string"
-          },
-          "required": true
+      "input": [{
+        "name": "apiPath",
+        "type": "string",
+        "info": "The API Path you want to check - make sure to not include base path and version",
+        "description": "The API Path you want to check - make sure to not include base path and version",
+        "schema": {
+          "title": "apiPath",
+          "type": "string"
+        },
+        "required": true
+      }],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
         }
+      },
+      "roles": [
+        "admin"
       ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapFindAdapterPath"
+      },
+      "task": true
+    },
+    {
+      "name": "iapSuspendAdapter",
+      "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
+      }],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing the result",
+        "description": "A JSON Object containing the adapter suspended status",
         "schema": {
           "title": "result",
           "type": "object"
@@ -113,12 +145,58 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/findPath"
+        "path": "/iapSuspendAdapter"
       },
       "task": true
     },
     {
-      "name": "troubleshoot",
+      "name": "iapUnsuspendAdapter",
+      "summary": "Unsuspends the adapter",
+      "description": "Unsuspends the adapter",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the adapter suspended status",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapUnsuspendAdapter"
+      },
+      "task": true
+    },
+    {
+      "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 adapter queue",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapGetAdapterQueue"
+      },
+      "task": true
+    },
+    {
+      "name": "iapTroubleshootAdapter",
       "summary": "Runs troubleshoot script for adapter",
       "description": "Runs troubleshoot script for adapter",
       "input": [
@@ -153,12 +231,12 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/troubleshoot"
+        "path": "/iapTroubleshootAdapter"
       },
       "task": true
     },
     {
-      "name": "runHealthcheck",
+      "name": "iapRunAdapterHealthcheck",
       "summary": "Runs healthcheck script for adapter",
       "description": "Runs healthcheck script for adapter",
       "input": [],
@@ -172,12 +250,12 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/runHealthcheck"
+        "path": "/iapRunAdapterHealthcheck"
       },
       "task": true
     },
     {
-      "name": "runConnectivity",
+      "name": "iapRunAdapterConnectivity",
       "summary": "Runs connectivity check script for adapter",
       "description": "Runs connectivity check script for adapter",
       "input": [],
@@ -195,12 +273,12 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/runConnectivity"
+        "path": "/iapRunAdapterConnectivity"
       },
       "task": true
     },
     {
-      "name": "runBasicGet",
+      "name": "iapRunAdapterBasicGet",
       "summary": "Runs basicGet script for adapter",
       "description": "Runs basicGet script for adapter",
       "input": [],
@@ -218,37 +296,21 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/runBasicGet"
+        "path": "/iapRunAdapterBasicGet"
       },
       "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": "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 suspended status",
+        "description": "A JSON Object containing status, code and the response from the mongo transaction",
         "schema": {
-          "title": "result",
+          "title": "res",
           "type": "object"
         }
       },
@@ -257,42 +319,75 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/suspend"
+        "path": "/iapMoveAdapterEntitiesToDB"
       },
       "task": true
     },
     {
-      "name": "unsuspend",
-      "summary": "Unsuspends the adapter",
-      "description": "Unsuspends the adapter",
-      "input": [],
-      "output": {
-        "name": "result",
-        "type": "object",
-        "description": "A JSON Object containing the adapter suspended status",
-        "schema": {
-          "title": "result",
-          "type": "object"
+      "name": "genericAdapterRequest",
+      "summary": "Makes the requested generic call",
+      "description": "Makes the requested generic call",
+      "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
         }
-      },
-      "roles": [
-        "admin"
       ],
-      "route": {
-        "verb": "POST",
-        "path": "/unsuspend"
-      },
-      "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",
-      "input": [],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing the adapter queue",
+        "description": "A JSON Object containing status, code and the result",
         "schema": {
           "title": "result",
           "type": "object"
@@ -303,14 +398,14 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/getQueue"
+        "path": "/genericAdapterRequest"
       },
       "task": true
     },
     {
-      "name": "genericAdapterRequest",
-      "summary": "Makes the requested generic call",
-      "description": "Makes the requested generic call",
+      "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",
@@ -382,10 +477,179 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/genericAdapterRequest"
+        "path": "/genericAdapterRequestNoBasePath"
       },
       "task": true
     },
+    {
+      "name": "getDevice",
+      "summary": "Get the Appliance",
+      "description": "Get the Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getDevice"
+      },
+      "task": false
+    },
+    {
+      "name": "getDevicesFiltered",
+      "summary": "Get Appliances that match the filter",
+      "description": "Get Appliances that match the filter",
+      "input": [
+        {
+          "name": "options",
+          "type": "object",
+          "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
+          "required": true,
+          "schema": {
+            "title": "options",
+            "type": "object"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "array",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "array"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getDevicesFiltered"
+      },
+      "task": false
+    },
+    {
+      "name": "isAlive",
+      "summary": "Checks the status for the provided Appliance",
+      "description": "Checks the status for the provided Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "boolean",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "boolean"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/isAlive"
+      },
+      "task": false
+    },
+    {
+      "name": "getConfig",
+      "summary": "Gets a config for the provided Appliance",
+      "description": "Gets a config for the provided Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        },
+        {
+          "name": "format",
+          "type": "string",
+          "info": "The format to be returned - this is ignored as we always return json",
+          "required": false,
+          "schema": {
+            "title": "format",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getConfig"
+      },
+      "task": false
+    },
+    {
+      "name": "iapGetDeviceCount",
+      "summary": "Gets a device count from the system",
+      "description": "Gets a device count from the system",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapGetDeviceCount"
+      },
+      "task": false
+    },
     {
       "name": "postDnaintentapiv1templateProgrammerproject",
       "summary": "Create Project",
@@ -7318,6 +7582,144 @@
       },
       "task": true
     },
+    {
+      "name": "postDnasystemapiv1sitesiteIddevice",
+      "summary": "Assign Device To Site",
+      "description": "Assigns list of devices to a site",
+      "input": [
+        {
+          "name": "request",
+          "type": "object",
+          "info": "request",
+          "required": true,
+          "schema": {
+            "title": "request",
+            "type": "object"
+          }
+        },
+        {
+          "name": "Runsync",
+          "type": "boolean",
+          "info": "Enable this parameter to execute the API and return a response synchronously",
+          "required": true,
+          "schema": {
+            "title": "Runsync",
+            "type": "boolean"
+          }
+        },
+        {
+          "name": "Persistbapioutput",
+          "type": "boolean",
+          "info": "Persist bapi sync response",
+          "required": true,
+          "schema": {
+            "title": "Persistbapioutput",
+            "type": "boolean"
+          }
+        },
+        {
+          "name": "Timeout",
+          "type": "number",
+          "info": "During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated",
+          "required": false,
+          "schema": {
+            "title": "Timeout",
+            "type": "number"
+          }
+        },
+        {
+          "name": "siteId",
+          "type": "string",
+          "info": "Site id to which the device is assigned",
+          "required": true,
+          "schema": {
+            "title": "siteId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/postDnasystemapiv1sitesiteIddevice"
+      },
+      "task": true
+    },
+    {
+      "name": "postDnaintentapiv1site",
+      "summary": "Create Site",
+      "description": "Creates site with area/building/floor with specified hierarchy.",
+      "input": [
+        {
+          "name": "request",
+          "type": "object",
+          "info": "request",
+          "required": true,
+          "schema": {
+            "title": "request",
+            "type": "object"
+          }
+        },
+        {
+          "name": "Runsync",
+          "type": "boolean",
+          "info": "Enable this parameter to execute the API and return a response synchronously",
+          "required": true,
+          "schema": {
+            "title": "Runsync",
+            "type": "boolean"
+          }
+        },
+        {
+          "name": "Timeout",
+          "type": "number",
+          "info": "During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated",
+          "required": false,
+          "schema": {
+            "title": "Timeout",
+            "type": "number"
+          }
+        },
+        {
+          "name": "Persistbapioutput",
+          "type": "boolean",
+          "info": "Persist bapi sync response",
+          "required": true,
+          "schema": {
+            "title": "Persistbapioutput",
+            "type": "boolean"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/postDnaintentapiv1site"
+      },
+      "task": true
+    },
     {
       "name": "postDnasystemapiv1site",
       "summary": "Create Site",