@itentialopensource/adapter-jenkins 0.1.7 → 0.3.0

package/pronghorn.json

@@ -10,7 +10,7 @@
   ],
   "methods": [
     {
-      "name": "updateAdapterConfiguration",
+      "name": "iapUpdateAdapterConfiguration",
       "summary": "Updates the adapter configuration",
       "description": "Updates the adapter configuration file with the provided changes",
       "input": [
@@ -63,6 +63,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": {
@@ -79,12 +89,97 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/updateAdapterConfiguration"
+        "path": "/iapUpdateAdapterConfiguration"
+      },
+      "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 adapter suspended status",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapSuspendAdapter"
+      },
+      "task": true
+    },
+    {
+      "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": "findPath",
+      "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": "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": [
@@ -114,12 +209,12 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/findPath"
+        "path": "/iapFindAdapterPath"
       },
       "task": true
     },
     {
-      "name": "troubleshoot",
+      "name": "iapTroubleshootAdapter",
       "summary": "Runs troubleshoot script for adapter",
       "description": "Runs troubleshoot script for adapter",
       "input": [
@@ -137,7 +232,11 @@
           "name": "persistFlag",
           "type": "boolean",
           "info": "Whether the input properties should be saved",
-          "required": true
+          "required": true,
+          "schema": {
+            "title": "persistFlag",
+            "type": "boolean"
+          }
         }
       ],
       "output": {
@@ -154,31 +253,35 @@
       ],
       "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": [],
       "output": {
         "name": "result",
         "type": "boolean",
-        "description": "Whether healthcheck passed or failed"
+        "description": "Whether healthcheck passed or failed",
+        "schema": {
+          "title": "result",
+          "type": "boolean"
+        }
       },
       "roles": [
         "admin"
       ],
       "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": [],
@@ -196,12 +299,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": [],
@@ -219,35 +322,52 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/runBasicGet"
+        "path": "/iapRunAdapterBasicGet"
       },
       "task": true
     },
     {
-      "name": "suspend",
-      "summary": "Suspends the adapter",
-      "description": "Suspends the adapter",
+      "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": "mode",
-          "type": "enum",
-          "enumerals": [
-            "pause",
-            "error"
-          ],
-          "info": "How incoming requests are handled. Defaults to 'pause'",
-          "description": "How incoming requests are handled. Defaults to 'pause'",
+          "name": "tasks",
+          "type": "array",
+          "description": "Tasks to deactivate",
           "schema": {
-            "title": "mode",
-            "type": "string"
-          },
-          "required": false
+            "title": "tasks",
+            "type": "array"
+          }
         }
       ],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing the adapter suspended status",
+        "description": "A JSON Object containing success status",
         "schema": {
           "title": "result",
           "type": "object"
@@ -258,19 +378,29 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/suspend"
+        "path": "/iapDeactivateTasks"
       },
       "task": true
     },
     {
-      "name": "unsuspend",
-      "summary": "Unsuspends the adapter",
-      "description": "Unsuspends the adapter",
-      "input": [],
+      "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 the adapter suspended status",
+        "description": "A JSON Object containing success status",
         "schema": {
           "title": "result",
           "type": "object"
@@ -281,19 +411,30 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/unsuspend"
+        "path": "/iapActivateTasks"
       },
       "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": [],
+      "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 the adapter queue",
+        "description": "A JSON Object containing status, code and the result",
         "schema": {
           "title": "result",
           "type": "object"
@@ -304,78 +445,111 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/getQueue"
+        "path": "/iapPopulateEntityCache"
       },
       "task": true
     },
     {
-      "name": "genericAdapterRequest",
-      "summary": "Makes the requested generic call",
-      "description": "Makes the requested generic call",
+      "name": "iapRetrieveEntitiesCache",
+      "summary": "Retrieves data from cache for specified entity type",
+      "description": "Retrieves data from cache for specified entity type",
       "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",
+          "name": "entityType",
           "type": "string",
-          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
-          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
+          "info": "entity of which to retrieve",
+          "required": true,
           "schema": {
-            "title": "restMethod",
+            "title": "entityType",
             "type": "string"
-          },
-          "required": true
+          }
         },
         {
-          "name": "queryData",
+          "name": "options",
           "type": "object",
-          "info": "the query parameters to be put on the url (optional)",
-          "description": "the query parameters to be put on the url (optional)",
+          "info": "settings of which data to return and how to return it",
+          "required": false,
           "schema": {
-            "title": "queryData",
+            "title": "options",
             "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": "/iapRetrieveEntitiesCache"
+      },
+      "task": true
+    },
+    {
+      "name": "getDevice",
+      "summary": "Get the Appliance",
+      "description": "Get the Appliance",
+      "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": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
           "schema": {
-            "title": "requestBody",
-            "type": "object"
-          },
-          "required": false
-        },
+            "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": "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": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
+          "required": true,
           "schema": {
-            "title": "addlHeaders",
+            "title": "options",
             "type": "object"
-          },
-          "required": false
+          }
         }
       ],
       "output": {
         "name": "result",
-        "type": "object",
+        "type": "array",
         "description": "A JSON Object containing status, code and the result",
         "schema": {
           "title": "result",
-          "type": "object"
+          "type": "array"
         }
       },
       "roles": [
@@ -383,7 +557,436 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/genericAdapterRequest"
+        "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
+        }
+      ],
+      "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
     },