screwdriver-api 7.0.5 → 7.0.6

package/.prettierrc.yaml

@@ -1 +1,6 @@
 trailingComma: "none"
+printWidth: 110
+singleQuote: true
+tabWidth: 4
+arrowParens: "avoid"
+htmlWhitespaceSensitivity: "strict"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-api",
-  "version": "7.0.5",
+  "version": "7.0.6",
   "description": "API server for the Screwdriver.cd service",
   "main": "index.js",
   "scripts": {

package/plugins/templates/README.md

@@ -131,6 +131,38 @@ If the deleted version was the last published, the API would set the `latest` at
 * `name` - Name of the template
 * `version` - Version of the template
 
+##### Get Report of Pipelines that use a template version
+
+`GET /templates/{name}/{version}/usage/pipelines`
+
+
+###### Arguments
+
+'name', 'version'
+
+* `name` - Name of the template
+* `version` - Version of the template
+
+###### Example response
+
+```json
+[
+    {
+        id: 4,
+        name: 'nathom/sd-uses-template',
+        scmRepo: {
+          branch: 'main',
+          name: 'nathom/sd-uses-template',
+          url: 'https://github.com/nathom/sd-uses-template/tree/main/pipe2',
+          rootDir: 'pipe2',
+          private: false
+        },
+        lastRun: '2023-07-31T17:15:37.510Z',
+        admins: { nathom: true }
+    },
+]
+```
+
 #### Template Tag
 Template tag allows fetching on template version by tag. For example, tag `mytemplate@1.1.0` as `stable`.
 

package/plugins/templates/getPipelineUsage.js

@@ -0,0 +1,50 @@
+'use strict';
+
+const boom = require('@hapi/boom');
+const joi = require('joi');
+const schema = require('screwdriver-data-schema');
+const nameSchema = schema.models.template.base.extract('name');
+const versionSchema = schema.models.template.base.extract('version');
+const tagSchema = schema.models.templateTag.base.extract('tag');
+const getSchema = schema.api.pipelineUsage.get;
+
+module.exports = () => ({
+    method: 'GET',
+    path: '/templates/{name}/{versionOrTag}/usage/pipelines',
+    options: {
+        description: 'Get information for the pipelines that are being used by a specific template version.',
+        notes: 'Returns information aboout the pipelines using the template version.',
+        tags: ['api', 'templates', 'pipelines', 'metrics'],
+        auth: {
+            strategies: ['token'],
+            scope: ['user', 'build']
+        },
+
+        handler: async (request, h) => {
+            const { templateFactory } = request.server.app;
+            const { name, versionOrTag } = request.params;
+
+            return templateFactory
+                .getPipelineUsage(`${name}@${versionOrTag}`)
+                .then(pipelines => {
+                    return h.response(pipelines);
+                })
+                .catch(err => {
+                    if (err.message === 'Template does not exist') {
+                        throw boom.notFound(`Template ${name}@${versionOrTag} does not exist`);
+                    } else {
+                        throw err;
+                    }
+                });
+        },
+        response: {
+            schema: getSchema
+        },
+        validate: {
+            params: joi.object({
+                name: nameSchema,
+                versionOrTag: joi.alternatives().try(versionSchema, tagSchema)
+            })
+        }
+    }
+});

package/plugins/templates/index.js

@@ -13,6 +13,7 @@ const removeTagRoute = require('./removeTag');
 const removeVersionRoute = require('./removeVersion');
 const updateTrustedRoute = require('./updateTrusted');
 const getTemplateByIdRoute = require('./getTemplateById');
+const getPipelineUsage = require('./getPipelineUsage');
 
 /**
  * Template API Plugin
@@ -87,7 +88,8 @@ const templatesPlugin = {
             removeTagRoute(),
             removeVersionRoute(),
             updateTrustedRoute(),
-            getTemplateByIdRoute()
+            getTemplateByIdRoute(),
+            getPipelineUsage()
         ]);
     }
 };