Merge pull request #4708 from cloud-gov/fix-specific-report-docs

add url to site build task response

Author: drewbo

api/controllers/site.js

@@ -196,6 +196,7 @@ module.exports = wrapHandlers({
       branch: sbt.branch,
       name: sbt.BuildTaskType.name,
       description: sbt.BuildTaskType.description,
+      url: sbt.BuildTaskType.url,
     }));
 
     return res.json(siteBuildTasks);

public/swagger/SiteBuildTask.json

@@ -0,0 +1,36 @@
+{
+  "type": "object",
+  "required": ["id", "name", "description", "startsWhen", "url"],
+  "properties": {
+    "id": {
+      "type": "string",
+      "enum": ["a11y", "owasp-zap"]
+    },
+    "sbtId": {
+      "type": "integer"
+    },
+    "name": {
+      "type": "string"
+    },
+    "description": {
+      "type": "string"
+    },
+    "metadata": {
+      "type": "object",
+      "properties": {
+        "rules": {
+          "type": "array"
+        },
+        "runDay": {
+          "type": "integer"
+        }
+      }
+    },
+    "url": {
+      "type": "string"
+    },
+    "branch": {
+      "type": "string"
+    }
+  }
+}

public/swagger/index.yml

@@ -1246,6 +1246,26 @@ paths:
           description: The site of the user environment variable is to be added to cannot be found
           schema:
             $ref: 'Error.json'
+  /site/{site_id}/task:
+    parameters:
+      - name: site_id
+        in: path
+        description: The id of the site
+        type: integer
+        required: true
+    get:
+      summary: Fetch the list of registered build task types for the given site
+      responses:
+        200:
+          description: A list of registered build task types for the given site
+          schema:
+            type: array
+            items:
+              $ref: 'SiteBuildTask.json'
+        404:
+          description: Not found
+          schema:
+            $ref: 'Error.json'
   /site/{site_id}/tasks:
     parameters:
       - name: site_id