screwdriver-api 7.0.109 → 7.0.110

package/package.json

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

package/plugins/pipelines/README.md

@@ -101,10 +101,17 @@ Example payload:
 `POST /pipelines/{id}/sync/pullrequests`
 
 #### Get all pipeline events
-`page`, `count`, `sort`, and `prNum` are optional
-Only PR events of specified PR number will be searched when `prNum` is set
 
-`GET /pipelines/{id}/events?page={pageNumber}&count={countNumber}&sort={sort}&prNum={prNumber}`
+Query Params:
+
+* `page` - *Optional* Specific page of the set to return
+* `count` - *Optional* Number of items per page
+* `sort` - *Optional* Sort rangekey by `ascending` or `descending` (default `descending`)
+* `type` - *Optional* Get pipeline or pr events (default `pipeline`)
+* `prNum` - *Optional* Return only PR events of specified PR number
+* `sha` - *Optional* Search `sha` and `configPipelineSha` for events
+
+`GET /pipelines/{id}/events?page={pageNumber}&count={countNumber}&sort={sort}&type={type}&prNum={prNumber}&sha={sha}`
 
 #### Get all pipeline builds
 `page`, `count`, `sort`, `latest`, `sortBy`, `fetchSteps`, `readOnly`, and `groupEventId` are optional

package/plugins/pipelines/listEvents.js

@@ -5,6 +5,8 @@ const joi = require('joi');
 const schema = require('screwdriver-data-schema');
 const eventListSchema = joi.array().items(schema.models.event.get).label('List of events');
 const prNumSchema = schema.models.event.base.extract('prNum');
+const shaSchema = schema.models.event.base.extract('sha');
+const typeSchema = schema.models.event.base.extract('type');
 const pipelineIdSchema = schema.models.pipeline.base.extract('id');
 
 module.exports = () => ({
@@ -21,6 +23,7 @@ module.exports = () => ({
 
         handler: async (request, h) => {
             const factory = request.server.app.pipelineFactory;
+            const { page, count, sha, prNum } = request.query;
 
             return factory
                 .get(request.params.id)
@@ -32,16 +35,25 @@ module.exports = () => ({
                     const eventType = request.query.type || 'pipeline';
                     const config = { params: { type: eventType } };
 
-                    if (request.query.page || request.query.count) {
+                    if (page || count) {
                         config.paginate = {
-                            page: request.query.page,
-                            count: request.query.count
+                            page,
+                            count
                         };
                     }
 
-                    if (request.query.prNum) {
+                    if (prNum) {
                         config.params.type = 'pr';
-                        config.params.prNum = request.query.prNum;
+                        config.params.prNum = prNum;
+                    }
+
+                    if (sha) {
+                        config.search = {
+                            field: ['sha', 'configPipelineSha'],
+                            // Do a search for sha
+                            // See https://www.w3schools.com/sql/sql_like.asp for syntax
+                            keyword: `${sha}%`
+                        };
                     }
 
                     return pipeline.getEvents(config);
@@ -60,8 +72,9 @@ module.exports = () => ({
             }),
             query: schema.api.pagination.concat(
                 joi.object({
-                    type: joi.string(),
+                    type: typeSchema,
                     prNum: prNumSchema,
+                    sha: shaSchema,
                     search: joi.forbidden(), // we don't support search for Pipeline list events
                     getCount: joi.forbidden() // we don't support getCount for Pipeline list events
                 })