@itentialopensource/adapter-adtran_mosaic_devicemanager 0.1.1 → 0.3.0

package/pronghorn.json

@@ -62,6 +62,16 @@
             "title": "action",
             "type": "string"
           }
+        },
+        {
+          "name" : "replace",
+          "type": "boolean",
+          "info": "True to replace entire mock data, false to merge/append",
+          "required": false,
+          "schema": {
+            "title": "replace",
+            "type" : "boolean"
+          }
         }
       ],
       "output": {
@@ -83,24 +93,30 @@
       "task": true
     },
     {
-      "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
-      }],
+      "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"
@@ -111,26 +127,15 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/iapFindAdapterPath"
+        "path": "/iapSuspendAdapter"
       },
       "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
-      }],
+      "name": "iapUnsuspendAdapter",
+      "summary": "Unsuspends the adapter",
+      "description": "Unsuspends the adapter",
+      "input": [],
       "output": {
         "name": "result",
         "type": "object",
@@ -145,19 +150,19 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/iapSuspendAdapter"
+        "path": "/iapUnsuspendAdapter"
       },
       "task": true
     },
     {
-      "name": "iapUnsuspendAdapter",
-      "summary": "Unsuspends the adapter",
-      "description": "Unsuspends the 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 adapter suspended status",
+        "description": "A JSON Object containing the adapter queue",
         "schema": {
           "title": "result",
           "type": "object"
@@ -168,19 +173,31 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/iapUnsuspendAdapter"
+        "path": "/iapGetAdapterQueue"
       },
       "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": [],
+      "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
+        }
+      ],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing the adapter queue",
+        "description": "A JSON Object containing the result",
         "schema": {
           "title": "result",
           "type": "object"
@@ -191,7 +208,7 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/iapGetAdapterQueue"
+        "path": "/iapFindAdapterPath"
       },
       "task": true
     },
@@ -214,7 +231,11 @@
           "name": "persistFlag",
           "type": "boolean",
           "info": "Whether the input properties should be saved",
-          "required": true
+          "required": true,
+          "schema": {
+            "title": "persistFlag",
+            "type": "boolean"
+          }
         }
       ],
       "output": {
@@ -243,7 +264,11 @@
       "output": {
         "name": "result",
         "type": "boolean",
-        "description": "Whether healthcheck passed or failed"
+        "description": "Whether healthcheck passed or failed",
+        "schema": {
+          "title": "result",
+          "type": "boolean"
+        }
       },
       "roles": [
         "admin"
@@ -324,64 +349,129 @@
       "task": true
     },
     {
-      "name": "genericAdapterRequest",
-      "summary": "Makes the requested generic call",
-      "description": "Makes the requested generic call",
+      "name": "iapDeactivateTasks",
+      "summary": "Deactivate the inputted tasks",
+      "description": "Deactivate the inputted tasks",
       "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",
+          "name": "tasks",
+          "type": "array",
+          "description": "Tasks to deactivate",
           "schema": {
-            "title": "uriPath",
-            "type": "string"
-          },
-          "required": true
-        },
+            "title": "tasks",
+            "type": "array"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing success status",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapDeactivateTasks"
+      },
+      "task": true
+    },
+    {
+      "name": "iapActivateTasks",
+      "summary": "Activate the inputted tasks",
+      "description": "activate the inputted tasks",
+      "input": [
         {
-          "name": "restMethod",
-          "type": "string",
-          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
-          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
+          "name": "tasks",
+          "type": "array",
+          "description": "Tasks to activate",
           "schema": {
-            "title": "restMethod",
-            "type": "string"
-          },
-          "required": true
-        },
+            "title": "tasks",
+            "type": "array"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing success status",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapActivateTasks"
+      },
+      "task": true
+    },
+    {
+      "name": "iapPopulateEntityCache",
+      "summary": "Populate the cache for the given entities",
+      "description": "Populate the cache for the given entities",
+      "input": [
         {
-          "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)",
+          "name": "entityTypes",
+          "type": "array",
+          "info": "the entity type(s) to populate",
+          "required": true,
           "schema": {
-            "title": "queryData",
-            "type": "object"
-          },
-          "required": false
-        },
+            "title": "entityTypes",
+            "type": "array"
+          }
+        }
+      ],
+      "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": "/iapPopulateEntityCache"
+      },
+      "task": true
+    },
+    {
+      "name": "iapRetrieveEntitiesCache",
+      "summary": "Retrieves data from cache for specified entity type",
+      "description": "Retrieves data from cache for specified entity type",
+      "input": [
         {
-          "name": "requestBody",
-          "type": "object",
-          "info": "the payload to be sent with the request (optional)",
-          "description": "the payload to be sent with the request (optional)",
+          "name": "entityType",
+          "type": "string",
+          "info": "entity of which to retrieve",
+          "required": true,
           "schema": {
-            "title": "requestBody",
-            "type": "object"
-          },
-          "required": false
+            "title": "entityType",
+            "type": "string"
+          }
         },
         {
-          "name": "addlHeaders",
+          "name": "options",
           "type": "object",
-          "info": "additional headers to be put on the call (optional)",
-          "description": "additional headers to be put on the call (optional)",
+          "info": "settings of which data to return and how to return it",
+          "required": false,
           "schema": {
-            "title": "addlHeaders",
+            "title": "options",
             "type": "object"
-          },
-          "required": false
+          }
         }
       ],
       "output": {
@@ -398,7 +488,7 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/genericAdapterRequest"
+        "path": "/iapRetrieveEntitiesCache"
       },
       "task": true
     },
@@ -571,6 +661,334 @@
       },
       "task": false
     },
+    {
+      "name": "iapExpandedGenericAdapterRequest",
+      "summary": "Makes the requested generic call with additional options",
+      "description": "Makes the requested generic call with additional options via metadata",
+      "input": [
+        {
+          "name": "metadata",
+          "type": "object",
+          "info": "metadata for the call (optional)",
+          "description": "metadata for the call - allows for many enhancements (optional)",
+          "schema": {
+            "title": "metadata",
+            "type": "object"
+          },
+          "required": false
+        },
+        {
+          "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": false
+        },
+        {
+          "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": false
+        },
+        {
+          "name": "pathVars",
+          "type": "object",
+          "info": "the parameters to be put within the url path (optional)",
+          "description": "the parameters to be put within the url path (optional)",
+          "schema": {
+            "title": "pathVars",
+            "type": "object"
+          },
+          "required": false
+        },
+        {
+          "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": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapExpandedGenericAdapterRequest"
+      },
+      "task": true
+    },
+    {
+      "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
+        }
+      ],
+      "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": "/genericAdapterRequest"
+      },
+      "task": true
+    },
+    {
+      "name": "genericAdapterRequestNoBasePath",
+      "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
+        }
+      ],
+      "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": "/genericAdapterRequestNoBasePath"
+      },
+      "task": true
+    },
+    {
+      "name": "iapRunAdapterLint",
+      "summary": "Run the adapter lint script to return the results",
+      "description": "Run the adapter lint script to return the results",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "string",
+        "description": "A string containing the run results",
+        "schema": {
+          "title": "result",
+          "type": "string"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "GET",
+        "path": "/iapRunAdapterLint"
+      },
+      "task": true
+    },
+    {
+      "name": "iapRunAdapterTests",
+      "summary": "Run the adapter test scripts (baseunit and unit) to return the results",
+      "description": "Run the adapter test scripts (baseunit and unit) to return the results",
+      "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": "GET",
+        "path": "/iapRunAdapterTests"
+      },
+      "task": true
+    },
+    {
+      "name": "iapGetAdapterInventory",
+      "summary": "Provide inventory information abbout the adapter",
+      "description": "Provide inventory information abbout the adapter",
+      "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": "GET",
+        "path": "/iapGetAdapterInventory"
+      },
+      "task": true
+    },
     {
       "name": "updateListOfDevicesConnectedToACS",
       "summary": "Add a new device to the list of devices connected to the ACS",