screwdriver-api 7.0.175 → 7.0.176

package/package.json

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

package/plugins/pipelines/README.md

@@ -107,6 +107,7 @@ 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`)
+* `sortBy` - *Optional* Field to sort by
 * `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
@@ -115,7 +116,8 @@ Query Params:
 `GET /pipelines/{id}/events?page={pageNumber}&count={countNumber}&sort={sort}&type={type}&prNum={prNumber}&sha={sha}`
 
 `GET /pipelines/{id}/events?id=gt:{eventId}&count={countNumber}` (greater than eventId)
-`GET /pipelines/{id}/events?id=lt:{eventId}&count={countNumber}` (less than eventId)
+
+`GET /pipelines/{id}/events?id=lt:{eventId}&count={countNumber}&sort=ascending` (less than eventId)
 
 #### Get all pipeline builds
 `page`, `count`, `sort`, `latest`, `sortBy`, `fetchSteps`, `readOnly`, and `groupEventId` are optional

package/plugins/pipelines/listEvents.js

@@ -17,7 +17,7 @@ const INEQUALITY_SIGNS = /^(gt|lt):([\d]+)$/;
 const queryIdSchema = joi
     .alternatives()
     .try(pipelineIdSchema, joi.string().regex(INEQUALITY_SIGNS))
-    .label('Query ID schema')
+    .description('Event ID; alternatively can use greater than or less than prefix (gt:/lt:)')
     .example('gt:12345');
 
 module.exports = () => ({
@@ -34,7 +34,7 @@ module.exports = () => ({
 
         handler: async (request, h) => {
             const factory = request.server.app.pipelineFactory;
-            const { page, count, sha, prNum, id } = request.query;
+            const { page, count, sha, prNum, id, sort, sortBy } = request.query;
 
             return factory
                 .get(request.params.id)
@@ -44,7 +44,7 @@ module.exports = () => ({
                     }
 
                     const eventType = request.query.type || 'pipeline';
-                    const config = { params: { type: eventType } };
+                    const config = { params: { type: eventType }, sort };
 
                     if (page || count) {
                         config.paginate = {
@@ -53,6 +53,10 @@ module.exports = () => ({
                         };
                     }
 
+                    if (sortBy) {
+                        config.sortBy = sortBy;
+                    }
+
                     if (prNum) {
                         config.params.type = 'pr';
                         config.params.prNum = prNum;