@itentialopensource/adapter-f5_bigiq 0.3.4 → 0.4.0

package/pronghorn.json

@@ -62,47 +62,22 @@
             "title": "action",
             "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": "/iapUpdateAdapterConfiguration"
-      },
-      "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",
+          "name" : "replace",
+          "type": "boolean",
+          "info": "True to replace entire mock data, false to merge/append",
+          "required": false,
           "schema": {
-            "title": "apiPath",
-            "type": "string"
-          },
-          "required": true
+            "title": "replace",
+            "type": "boolean"
+          }
         }
       ],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing the result",
+        "description": "A JSON Object containing status, code and the result",
         "schema": {
           "title": "result",
           "type": "object"
@@ -113,7 +88,7 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/iapFindAdapterPath"
+        "path": "/iapUpdateAdapterConfiguration"
       },
       "task": true
     },
@@ -202,6 +177,41 @@
       },
       "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
+        }
+      ],
+      "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": "iapTroubleshootAdapter",
       "summary": "Runs troubleshoot script for adapter",
@@ -221,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": {
@@ -250,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"
@@ -274,25 +292,462 @@
           "title": "result",
           "type": "object"
         }
-      },
-      "roles": [
-        "admin"
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapRunAdapterConnectivity"
+      },
+      "task": true
+    },
+    {
+      "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 test results",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapRunAdapterBasicGet"
+      },
+      "task": true
+    },
+    {
+      "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": "res",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the response from the mongo transaction",
+        "schema": {
+          "title": "res",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapMoveAdapterEntitiesToDB"
+      },
+      "task": true
+    },
+    {
+      "name": "iapDeactivateTasks",
+      "summary": "Deactivate the inputted tasks",
+      "description": "Deactivate the inputted tasks",
+      "input": [
+        {
+          "name": "tasks",
+          "type": "array",
+          "description": "Tasks to deactivate",
+          "schema": {
+            "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": "tasks",
+          "type": "array",
+          "description": "Tasks to activate",
+          "schema": {
+            "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": "entityTypes",
+          "type": "array",
+          "info": "the entity type(s) to populate",
+          "required": true,
+          "schema": {
+            "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": "entityType",
+          "type": "string",
+          "info": "entity of which to retrieve",
+          "required": true,
+          "schema": {
+            "title": "entityType",
+            "type": "string"
+          }
+        },
+        {
+          "name": "options",
+          "type": "object",
+          "info": "settings of which data to return and how to return it",
+          "required": false,
+          "schema": {
+            "title": "options",
+            "type": "object"
+          }
+        }
+      ],
+      "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": "/iapRetrieveEntitiesCache"
+      },
+      "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": "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
+        }
       ],
-      "route": {
-        "verb": "POST",
-        "path": "/iapRunAdapterConnectivity"
-      },
-      "task": true
-    },
-    {
-      "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 test results",
+        "description": "A JSON Object containing status, code and the result",
         "schema": {
           "title": "result",
           "type": "object"
@@ -303,30 +758,7 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/iapRunAdapterBasicGet"
-      },
-      "task": true
-    },
-    {
-      "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": "res",
-        "type": "object",
-        "description": "A JSON Object containing status, code and the response from the mongo transaction",
-        "schema": {
-          "title": "res",
-          "type": "object"
-        }
-      },
-      "roles": [
-        "admin"
-      ],
-      "route": {
-        "verb": "POST",
-        "path": "/iapMoveAdapterEntitiesToDB"
+        "path": "/iapExpandedGenericAdapterRequest"
       },
       "task": true
     },
@@ -411,8 +843,8 @@
     },
     {
       "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",
+      "summary": "Makes the requested generic call",
+      "description": "Makes the requested generic call",
       "input": [
         {
           "name": "uriPath",
@@ -489,133 +921,33 @@
       "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"
-          }
-        }
-      ],
+      "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": "boolean",
-        "description": "A JSON Object containing status, code and the result",
+        "type": "string",
+        "description": "A string containing the run results",
         "schema": {
           "title": "result",
-          "type": "boolean"
+          "type": "string"
         }
       },
       "roles": [
         "admin"
       ],
       "route": {
-        "verb": "POST",
-        "path": "/isAlive"
+        "verb": "GET",
+        "path": "/iapRunAdapterLint"
       },
-      "task": false
+      "task": true
     },
     {
-      "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"
-          }
-        }
-      ],
+      "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",
@@ -629,15 +961,15 @@
         "admin"
       ],
       "route": {
-        "verb": "POST",
-        "path": "/getConfig"
+        "verb": "GET",
+        "path": "/iapRunAdapterTests"
       },
-      "task": false
+      "task": true
     },
     {
-      "name": "iapGetDeviceCount",
-      "summary": "Gets a device count from the system",
-      "description": "Gets a device count from the system",
+      "name": "iapGetAdapterInventory",
+      "summary": "Provide inventory information abbout the adapter",
+      "description": "Provide inventory information abbout the adapter",
       "input": [],
       "output": {
         "name": "result",
@@ -652,10 +984,10 @@
         "admin"
       ],
       "route": {
-        "verb": "POST",
-        "path": "/iapGetDeviceCount"
+        "verb": "GET",
+        "path": "/iapGetAdapterInventory"
       },
-      "task": false
+      "task": true
     },
     {
       "name": "getAlertRule",
@@ -12995,6 +13327,97 @@
         "path": "/getRemoveDeviceTrustStatusById"
       },
       "task": true
+    },
+    {
+      "name": "updateDeviceUpgrade",
+      "summary": "Update Device Upgrade",
+      "description": "Update Device Upgrade",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": ": object",
+          "required": true,
+          "schema": {
+            "title": "body",
+            "type": "object"
+          }
+        }
+      ],
+      "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": "/updateDeviceUpgrade"
+      },
+      "task": true
+    },
+    {
+      "name": "getAllUpgradeInstances",
+      "summary": "Get All Upgrade Instances",
+      "description": "Get All Upgrade Instances",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "body",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "GET",
+        "path": "/getAllUpgradeInstances"
+      },
+      "task": true
+    },
+    {
+      "name": "getUpgradeInstancesById",
+      "summary": "Get Upgrade Instance By Id",
+      "description": "Get Upgrade Instance By Id",
+      "input": [
+        {
+          "name": "upgradeTaskId",
+          "type": "string",
+          "info": ": string",
+          "required": true,
+          "schema": {
+            "title": "upgradeTaskId",
+            "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": "/getUpgradeInstancesById"
+      },
+      "task": true
     }
   ],
   "views": []