screwdriver-api 7.0.121 → 7.0.123

package/README.md

@@ -24,7 +24,7 @@ For more information about Screwdriver, check out our [homepage](http://screwdri
 
 ### Plugins
 
-This API comes preloaded with 16 (sixteen) resources:
+This API comes preloaded with 18 (eighteen) resources:
 
  - [auth](plugins/auth/README.md)
  - [banners](plugins/banners/README.md)
@@ -37,6 +37,8 @@ This API comes preloaded with 16 (sixteen) resources:
  - [jobs](plugins/jobs/README.md)
  - [pipelines](plugins/pipelines/README.md)
  - [secrets](plugins/secrets/README.md)
+ - [stages](plugins/stages/README.md)
+ - [stageBuilds](plugins/stageBuilds/README.md)
  - [templates](plugins/templates/README.md)
  - [tokens](plugins/tokens/README.md)
  - [webhooks](plugins/webhooks/README.md)

package/lib/registerPlugins.js

@@ -54,6 +54,7 @@ async function registerResourcePlugins(server, config) {
         'templates',
         'tokens',
         'secrets',
+        'stages',
         'users',
         'webhooks',
         'stats',

package/package.json

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

package/plugins/pipelines/README.md

@@ -139,7 +139,9 @@ Arguments:
 
 #### Get all stages for a single pipeline
 
-`GET /pipelines/{id}/stages`
+`page`, `count`, `sort`, `sortBy`, and `name` optional
+
+`GET /pipelines/{id}/stages?page={pageNumber}&count={countNumber}&sort={sort}&name={stageName}`
 
 #### Get all pipeline secrets
 

package/plugins/pipelines/listStages.js

@@ -4,7 +4,8 @@ const boom = require('@hapi/boom');
 const joi = require('joi');
 const schema = require('screwdriver-data-schema');
 const pipelineIdSchema = schema.models.pipeline.base.extract('id');
-const stageListSchema = joi.array().items(schema.models.stage.base).label('List of stages');
+const nameSchema = schema.models.stage.base.extract('name');
+const stageListSchema = schema.models.stage.list;
 
 module.exports = () => ({
     method: 'GET',
@@ -20,6 +21,7 @@ module.exports = () => ({
 
         handler: async (request, h) => {
             const { pipelineFactory, stageFactory } = request.server.app;
+            const { name, sort, sortBy, page, count } = request.query;
             const pipelineId = request.params.id;
 
             return pipelineFactory
@@ -30,9 +32,31 @@ module.exports = () => ({
                     }
 
                     const config = {
-                        params: { pipelineId }
+                        params: { pipelineId },
+                        sort
                     };
 
+                    if (name) {
+                        config.params = {
+                            ...config.params,
+                            name
+                        };
+                    }
+
+                    if (sortBy) {
+                        config.sortBy = sortBy;
+                    }
+
+                    if (page) {
+                        config.paginate = config.paginate || {};
+                        config.paginate.page = page;
+                    }
+
+                    if (count) {
+                        config.paginate = config.paginate || {};
+                        config.paginate.count = count;
+                    }
+
                     return stageFactory.list(config);
                 })
                 .then(stages => h.response(stages.map(s => s.toJson())))
@@ -49,6 +73,7 @@ module.exports = () => ({
             }),
             query: schema.api.pagination.concat(
                 joi.object({
+                    name: nameSchema,
                     search: joi.forbidden() // we don't support search for Pipeline list stages
                 })
             )

package/plugins/stages/README.md

@@ -27,6 +27,11 @@ server.register({
 
 ### Routes
 
+#### Get single stage
+
+`GET /stages/{id}`
+
 #### Get a listing of all stage builds for a stage
 
 `GET /stages/{id}/stageBuilds`
+`GET /stages/{id}/stageBuilds?eventId={eventId}`

package/plugins/stages/get.js

@@ -0,0 +1,46 @@
+'use strict';
+
+const boom = require('@hapi/boom');
+const joi = require('joi');
+const schema = require('screwdriver-data-schema');
+const getSchema = schema.models.stage.get;
+const idSchema = schema.models.stage.base.extract('id');
+
+module.exports = () => ({
+    method: 'GET',
+    path: '/stages/{id}',
+    options: {
+        description: 'Get a single stage',
+        notes: 'Returns a stage record',
+        tags: ['api', 'stages'],
+        auth: {
+            strategies: ['token'],
+            scope: ['user', 'build', 'pipeline']
+        },
+
+        handler: async (request, h) => {
+            const { stageFactory } = request.server.app;
+
+            return stageFactory
+                .get(request.params.id)
+                .then(model => {
+                    if (!model) {
+                        throw boom.notFound(`Stage ${request.params.id} does not exist`);
+                    }
+
+                    return h.response(model.toJson());
+                })
+                .catch(err => {
+                    throw err;
+                });
+        },
+        response: {
+            schema: getSchema
+        },
+        validate: {
+            params: joi.object({
+                id: idSchema
+            })
+        }
+    }
+});

package/plugins/stages/index.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const getStageBuildsRoute = require('./stageBuilds/list');
+const getRoute = require('./get');
 
 /**
  * Stage API Plugin
@@ -12,7 +13,7 @@ const getStageBuildsRoute = require('./stageBuilds/list');
 const stagesPlugin = {
     name: 'stages',
     async register(server) {
-        server.route([getStageBuildsRoute()]);
+        server.route([getStageBuildsRoute(), getRoute()]);
     }
 };
 

package/plugins/stages/stageBuilds/list.js

@@ -29,9 +29,9 @@ module.exports = () => ({
                 }
             };
 
-            return stageFactory.get(config.params.stageId).then(async stage => {
+            return stageFactory.get(request.params.id).then(async stage => {
                 if (!stage) {
-                    throw boom.notFound(`Stage ${config.params.stageId} does not exist`);
+                    throw boom.notFound(`Stage ${request.params.id} does not exist`);
                 }
 
                 if (page || count) {
@@ -60,7 +60,9 @@ module.exports = () => ({
             }),
             query: schema.api.pagination.concat(
                 joi.object({
-                    eventId: eventIdSchema
+                    eventId: eventIdSchema,
+                    search: joi.forbidden(), // we don't support search for Stage list stageBuilds
+                    getCount: joi.forbidden()
                 })
             )
         }